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