docs/rel-notes.rst

   1
   2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   3 .. SPDX-License-Identifier: CC-BY-4.0
   4 .. CAUTION: this document is generated from source in doc/src/rtd.
   5 .. To make changes edit the source and recompile the document.
   6 .. Do NOT make changes directly to .rst or .md files.
   7
   8
   9 RMR Release Notes
  10 ============================================================================================
  11
  12 The following is a list of release highlights for the core
  13 RMR library and wrappers which are housed in the same
  14 repository. These are extracted directly from the
  15 CHANGES_*.txt files at the repo root; please refer to those
  16 files for a completely up to date listing of API changes (as
  17 generated documents may lag).
  18
  19 The RMR repo houses two distinct release entities: the core
  20 RMR package and the python wrapper package. To avoid naming
  21 conflicts (tags mostly) The core package uses odd major
  22 version numbers (e.g. 3.2.1) and the wrapper package uses
  23 even major version numbers. The release notes are split into
  24 two sections; please be sure to scroll to the section that is
  25 appropriate.
  26
  27 Core RMR Changes
  28 --------------------------------------------------------------------------------------------
  29
  30
  31 2020 March 10; version 3.5.1
  32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33
  34 Add missing health check message types.
  35
  36 2020 March 9; version 3.5.0
  37 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  38
  39 Added new wormhole send function: rmr_wh_call().
  40
  41
  42 2020 March 6; version 3.4.0
  43 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  44
  45 Add new wormhole state function: rmr_wh_state().
  46
  47
  48 2020 March 5; Version 3.3.1
  49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50
  51 Correct several "bugs" identified by automatic code analysis.
  52
  53
  54 2020 March 4; Version 3.3.0
  55 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  56
  57 Add SI95 based unit testing Health check support binary added
  58 (reason for minor bump)
  59
  60
  61 2020 February 26; version 3.2.5
  62 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  63
  64 Fix source address bug in SI95 receive/send funcitons. Fix
  65 threading issues involving session disconnection in SI95
  66 Remove unused SI95 status variable.
  67
  68
  69 2020 February 24; version 3.2.4
  70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71
  72 Fix meid bug (RIC-220) causing core dump.
  73
  74
  75 2020 February 21; version 3.2.3
  76 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  77
  78 Add meid routing support to the SI95 interface.
  79
  80
  81 2020 February 20; version 3.2.2
  82 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  83
  84 Fix receive thread related core dump (ring early unlock).
  85
  86
  87 2020 February 19; version 3.2.1
  88 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  89
  90 Added missing message types (E2-Setup)
  91
  92
  93 2020 February 18; version 3.2.0
  94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  95
  96 Added support for new Route Manager and it's ability to
  97 accept a request for table update.
  98
  99
 100 2020 February 14; version 3.1.3
 101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 102
 103 Fix bug in SIsend which was causing a core dump in some cases
 104 where the application attempted to send on a connection that
 105 had disconnected. (RIC-207).
 106
 107
 108 2020 February 6; version 3.1.2
 109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 110
 111 Fix disconnection detection bug in interface to SI95.
 112
 113
 114 2020 January 31; verison 3.1.1
 115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 116
 117 Allow route table thread logging to be completely disabled
 118 when logging is turned off.
 119
 120
 121 2020 January 26; verison 3.1.0
 122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 123
 124 First step to allowing the user programme to control messages
 125 written to standard error. Introduces the rmr_set_vlevel()
 126 function, and related environment variable.
 127
 128
 129 2020 January 24; verison 3.0.5
 130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 131
 132 Fix bug in SI95 with receive buffer allocation.
 133
 134
 135 2020 January 23; verison 3.0.4
 136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 137
 138 Fix bug in SI95 causing excessive CPU usage on poll.
 139
 140
 141 2020 January 22; verison 3.0.3
 142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 143
 144 Enable thread support for multiple receive threads.
 145
 146
 147 2020 January 21; verison 3.0.2
 148 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 149
 150 Fix bug in SI95 (missing reallocate payload function).
 151
 152
 153 2020 January 20; verison 3.0.1
 154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 155
 156 Enable support for dynamic route table updates via RMR
 157 session.
 158
 159
 160 2020 January 16; version 3.0.0
 161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 162
 163 Introduce support for SI95 transport library to replace NNG.
 164 (RMR library versions will use leading odd numbers to avoid
 165 tag collisions with the wrapper tags which will use even
 166 numbers.)
 167
 168
 169 2019 December 9; version 1.13.1
 170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 171
 172 Correct documentation and missing rel-notes update for RTD.
 173
 174
 175 2019 December 6; version 1.13.0
 176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 177
 178 Add ability to route messages based on the MEID in a message
 179 combined with the message type/subscription-ID.
 180
 181
 182 2019 November 14; version 1.11.1 (Amber)
 183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 184
 185 Fix bug in payload reallocation function; correct length of
 186 payload was not always copied.
 187
 188
 189 2019 November 13; version 1.12.1
 190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 191
 192 New message type constants added to support A1.
 193
 194
 195 2019 November 4; version 1.11.0 (Amber)
 196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 197
 198 Version bump to move away from the 1.10.* to distinguish
 199 between release A and the trial.
 200
 201
 202 2019 November 7; version 1.12.0
 203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 204
 205 Version cut to support continued development for next release
 206 preserving the 1.11.* versions for release 1 (Amber) and
 207 related fixes.
 208
 209
 210 2019 October 31; version 1.10.2
 211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 212
 213 Provide the means to increase the payload size of a received
 214 message without losing the data needed to use the
 215 rmr_rts_msg() funciton.
 216
 217
 218 2019 October 21; version 1.10.1
 219 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 220
 221 Fix to prevent null message buffer from being returned by the
 222 timeout receive function if the function is passed one to
 223 reuse.
 224
 225
 226 2019 October 21; version 1.10.1
 227 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 228
 229 Add periodic dump of send count info to stderr.
 230
 231
 232 2019 September 27; version 1.9.0
 233 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 234
 235 Python bindings added receive all queued function and
 236 corrected a unit test
 237
 238
 239 2019 September 25; version 1.8.3
 240 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 241
 242 Correct application level test issue causing timing problems
 243 during jenkins verification testing at command and merge
 244
 245 Handle the NNG connection shutdown status which may now be
 246 generated when a connection throug a proxy is reset.
 247
 248
 249 2019 September 25; version 1.8.2
 250 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 251
 252 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
 253
 254
 255 2019 September 19; version 1.8.1
 256 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 257
 258 Correct missing constant for wrappers.
 259
 260
 261 2019 September 19; version 1.8.0
 262 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 263
 264 New message types added: RAN_CONNECTED, RAN_RESTARTED,
 265 RAN_RECONFIGURED
 266
 267
 268 2019 September 17; version 1.7.0
 269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 270
 271 Initial connection mode now defaults to asynchronous. Set
 272 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
 273 invoked to revert to synchronous first TCP connections.
 274 (Recovery connection attempts have always been asynchronous).
 275
 276
 277 2019 September 3; version 1.6.0
 278 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 279
 280 Fix bug in the rmr_rts_msg() function. If a return to sender
 281 message failed, the source IP address was not correctly
 282 adjusted and could cause the message to be "reflected" back
 283 to the sender on a retry.
 284
 285 Added the ability to set the source "ID" via an environment
 286 var (RMR_SRC_ID). When present in the environment, the string
 287 will be placed in to the message header as the source and
 288 thus be used by an application calling rmr_rts_smg() to
 289 return a response to the sender. If this environment variable
 290 is not present, the host name (original behaviour) is used.
 291
 292
 293 2019 August 26; version 1.4.0
 294 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 295
 296 New message types were added.
 297
 298
 299 2019 August 16; version 1.3.0
 300 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 301
 302 New mesage types added.
 303
 304
 305 2019 August 13; version 1.2.0 (API change, non-breaking)
 306 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 307
 308 The function rmr_get_xact() was added to proide a convenient
 309 way to extract the transaction field from a message.
 310
 311
 312 2019 August 8; version 1.1.0 (API change)
 313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 314
 315 This change should be backward compatable/non-breaking A new
 316 field has been added to the message buffer (rmr_mbuf_t). This
 317 field (tp_state) is used to communicate the errno value that
 318 the transport mechanism might set during send and/or receive
 319 operations. C programmes should continue to use errno
 320 directly, but in some environments wrappers may not be able
 321 to access errno and this provides the value to them. See the
 322 rmr_alloc_msg manual page for more details.
 323
 324
 325 2019 August 6; version 1.0.45 (build changes)
 326 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 327
 328 Support for the Nanomsg transport library has been dropped.
 329 The library librmr.* will no longer be included in packages.
 330
 331 Packages will install RMR libraries into the system preferred
 332 target directory. On some systems this is /usr/local/lib and
 333 on others it is /usr/local/lib64. The diretory is determined
 334 by the sytem on which the package is built and NOT by the
 335 system installing the package, so it's possible that the RMR
 336 libraries end up in a strange location if the .deb or .rpm
 337 file was generated on a Linux flavour that has a different
 338 preference than the one where the package is installed.
 339
 340
 341 2019 August 6; version 1.0.44 (API change)
 342 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 343
 344 Added a new message type constant.
 345
 346
 347 2019 July 15; Version 1.0.39 (bug fix)
 348 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 349
 350 Prevent unnecessary usleep in retry loop.
 351
 352
 353 2019 July 12; Version 1.0.38 (API change)
 354 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 355
 356 Added new message types to RIC_message_types.h.
 357
 358
 359 2019 July 11; Version 1.0.37
 360 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 361
 362
 363 librmr and librmr_nng - Add message buffer API function
 364 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
 365 package).
 366
 367
 368 Wrapper Changes
 369 --------------------------------------------------------------------------------------------
 370
 371
 372 2020 February 29; Version 2.4.0
 373 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 374
 375 Add consolidated testing under CMake Add support binary for
 376 health check (SI95 only)
 377
 378
 379 2020 February 28; Version 2.3.6
 380 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 381
 382 Fix bug in Rt. Mgr comm which prevented table ID from being
 383 sent on ack message (RIC-232).