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 January 24; verison 3.0.5
  19 --------------------------------------------------------------------------------------------
  20
  21 Fix bug in SI95 with receive buffer allocation.
  22
  23
  24 2020 January 23; verison 3.0.4
  25 --------------------------------------------------------------------------------------------
  26
  27 Fix bug in SI95 causing excessive CPU usage on poll.
  28
  29
  30 2020 January 22; verison 3.0.3
  31 --------------------------------------------------------------------------------------------
  32
  33 Enable thread support for multiple receive threads.
  34
  35
  36 2020 January 21; verison 3.0.2
  37 --------------------------------------------------------------------------------------------
  38
  39 Fix bug in SI95 (missing reallocate payload function).
  40
  41
  42 2020 January 20; verison 3.0.1
  43 --------------------------------------------------------------------------------------------
  44
  45 Enable support for dynamic route table updates via RMR
  46 session.
  47
  48
  49 2020 January 16; version 3.0.0
  50 --------------------------------------------------------------------------------------------
  51
  52 Introduce support for SI95 transport library to replace NNG.
  53 (RMR library versions will use leading odd numbers to avoid
  54 tag collisions with the wrapper tags which will use even
  55 numbers.)
  56
  57
  58 2019 December 9; version 1.13.1
  59 --------------------------------------------------------------------------------------------
  60
  61 Correct documentation and missing rel-notes update for RTD.
  62
  63
  64 2019 December 6; version 1.13.0
  65 --------------------------------------------------------------------------------------------
  66
  67 Add ability to route messages based on the MEID in a message
  68 combined with the message type/subscription-ID.
  69
  70
  71
  72 2019 November 14; version 1.11.1 (Amber)
  73 --------------------------------------------------------------------------------------------
  74
  75 Fix bug in payload reallocation function; correct length of
  76 payload was not always copied.
  77
  78
  79 2019 November 13; version 1.12.1
  80 --------------------------------------------------------------------------------------------
  81
  82 New message type constants added to support A1.
  83
  84
  85 2019 November 4; version 1.11.0 (Amber)
  86 --------------------------------------------------------------------------------------------
  87
  88 Version bump to move away from the 1.10.* to distinguish
  89 between release A and the trial.
  90
  91
  92 2019 November 7; version 1.12.0
  93 --------------------------------------------------------------------------------------------
  94
  95 Version cut to support continued development for next release
  96 preserving the 1.11.* versions for release 1 (Amber) and
  97 related fixes.
  98
  99
 100 2019 October 31; version 1.10.2
 101 --------------------------------------------------------------------------------------------
 102
 103 Provide the means to increase the payload size of a received
 104 message without losing the data needed to use the
 105 rmr_rts_msg() funciton.
 106
 107
 108 2019 October 21; version 1.10.1
 109 --------------------------------------------------------------------------------------------
 110
 111 Fix to prevent null message buffer from being returned by the
 112 timeout receive function if the function is passed one to
 113 reuse.
 114
 115
 116 2019 October 21; version 1.10.1
 117 --------------------------------------------------------------------------------------------
 118
 119 Add periodic dump of send count info to stderr.
 120
 121
 122 2019 September 27; version 1.9.0
 123 --------------------------------------------------------------------------------------------
 124
 125 Python bindings added receive all queued function and
 126 corrected a unit test
 127
 128
 129 2019 September 25; version 1.8.3
 130 --------------------------------------------------------------------------------------------
 131
 132 Correct application level test issue causing timing problems
 133 during jenkins verification testing at command and merge
 134
 135 Handle the NNG connection shutdown status which may now be
 136 generated when a connection throug a proxy is reset.
 137
 138
 139 2019 September 25; version 1.8.2
 140 --------------------------------------------------------------------------------------------
 141
 142 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
 143
 144
 145 2019 September 19; version 1.8.1
 146 --------------------------------------------------------------------------------------------
 147
 148 Correct missing constant for wrappers.
 149
 150
 151 2019 September 19; version 1.8.0
 152 --------------------------------------------------------------------------------------------
 153
 154 New message types added: RAN_CONNECTED, RAN_RESTARTED,
 155 RAN_RECONFIGURED
 156
 157
 158 2019 September 17; version 1.7.0
 159 --------------------------------------------------------------------------------------------
 160
 161 Initial connection mode now defaults to asynchronous. Set
 162 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
 163 invoked to revert to synchronous first TCP connections.
 164 (Recovery connection attempts have always been asynchronous).
 165
 166
 167 2019 September 3; version 1.6.0
 168 --------------------------------------------------------------------------------------------
 169
 170 Fix bug in the rmr_rts_msg() function. If a return to sender
 171 message failed, the source IP address was not correctly
 172 adjusted and could cause the message to be "reflected" back
 173 to the sender on a retry.
 174
 175 Added the ability to set the source "ID" via an environment
 176 var (RMR_SRC_ID). When present in the environment, the string
 177 will be placed in to the message header as the source and
 178 thus be used by an application calling rmr_rts_smg() to
 179 return a response to the sender. If this environment variable
 180 is not present, the host name (original behaviour) is used.
 181
 182
 183 2019 August 26; version 1.4.0
 184 --------------------------------------------------------------------------------------------
 185
 186 New message types were added.
 187
 188
 189 2019 August 16; version 1.3.0
 190 --------------------------------------------------------------------------------------------
 191
 192 New mesage types added.
 193
 194
 195 2019 August 13; version 1.2.0 (API change, non-breaking)
 196 --------------------------------------------------------------------------------------------
 197
 198 The function rmr_get_xact() was added to proide a convenient
 199 way to extract the transaction field from a message.
 200
 201
 202 2019 August 8; version 1.1.0 (API change)
 203 --------------------------------------------------------------------------------------------
 204
 205 This change should be backward compatable/non-breaking A new
 206 field has been added to the message buffer (rmr_mbuf_t). This
 207 field (tp_state) is used to communicate the errno value that
 208 the transport mechanism might set during send and/or receive
 209 operations. C programmes should continue to use errno
 210 directly, but in some environments wrappers may not be able
 211 to access errno and this provides the value to them. See the
 212 rmr_alloc_msg manual page for more details.
 213
 214
 215 2019 August 6; version 1.0.45 (build changes)
 216 --------------------------------------------------------------------------------------------
 217
 218 Support for the Nanomsg transport library has been dropped.
 219 The library librmr.* will no longer be included in packages.
 220
 221 Packages will install RMR libraries into the system preferred
 222 target directory. On some systems this is /usr/local/lib and
 223 on others it is /usr/local/lib64. The diretory is determined
 224 by the sytem on which the package is built and NOT by the
 225 system installing the package, so it's possible that the RMR
 226 libraries end up in a strange location if the .deb or .rpm
 227 file was generated on a Linux flavour that has a different
 228 preference than the one where the package is installed.
 229
 230
 231 2019 August 6; version 1.0.44 (API change)
 232 --------------------------------------------------------------------------------------------
 233
 234 Added a new message type constant.
 235
 236
 237 2019 July 15; Version 1.0.39 (bug fix)
 238 --------------------------------------------------------------------------------------------
 239
 240 Prevent unnecessary usleep in retry loop.
 241
 242
 243 2019 July 12; Version 1.0.38 (API change)
 244 --------------------------------------------------------------------------------------------
 245
 246 Added new message types to RIC_message_types.h.
 247
 248
 249 2019 July 11; Version 1.0.37
 250 --------------------------------------------------------------------------------------------
 251
 252
 253 librmr and librmr_nng - Add message buffer API function
 254 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
 255 package).
 256