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