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.
10 ============================================================================================
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).
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
28 --------------------------------------------------------------------------------------------
31 2020 March 18; version 3.6.0
32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34 Add message types to support traffic steering
37 2020 March 16; version 3.5.2
38 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 Correct bug in the meid table parser that prevented the
41 ack/nack of meid tables (RIC-273)
44 2020 March 10; version 3.5.1
45 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47 Add missing health check message types.
49 2020 March 9; version 3.5.0
50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52 Added new wormhole send function: rmr_wh_call().
55 2020 March 6; version 3.4.0
56 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58 Add new wormhole state function: rmr_wh_state().
61 2020 March 5; Version 3.3.1
62 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
64 Correct several "bugs" identified by automatic code analysis.
67 2020 March 4; Version 3.3.0
68 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70 Add SI95 based unit testing Health check support binary added
71 (reason for minor bump)
74 2020 February 26; version 3.2.5
75 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
82 2020 February 24; version 3.2.4
83 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
85 Fix meid bug (RIC-220) causing core dump.
88 2020 February 21; version 3.2.3
89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91 Add meid routing support to the SI95 interface.
94 2020 February 20; version 3.2.2
95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
97 Fix receive thread related core dump (ring early unlock).
100 2020 February 19; version 3.2.1
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103 Added missing message types (E2-Setup)
106 2020 February 18; version 3.2.0
107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109 Added support for new Route Manager and it's ability to
110 accept a request for table update.
113 2020 February 14; version 3.1.3
114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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).
121 2020 February 6; version 3.1.2
122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
124 Fix disconnection detection bug in interface to SI95.
127 2020 January 31; verison 3.1.1
128 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130 Allow route table thread logging to be completely disabled
131 when logging is turned off.
134 2020 January 26; verison 3.1.0
135 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
142 2020 January 24; verison 3.0.5
143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145 Fix bug in SI95 with receive buffer allocation.
148 2020 January 23; verison 3.0.4
149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 Fix bug in SI95 causing excessive CPU usage on poll.
154 2020 January 22; verison 3.0.3
155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
157 Enable thread support for multiple receive threads.
160 2020 January 21; verison 3.0.2
161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
163 Fix bug in SI95 (missing reallocate payload function).
166 2020 January 20; verison 3.0.1
167 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
169 Enable support for dynamic route table updates via RMR
173 2020 January 16; version 3.0.0
174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
182 2019 December 9; version 1.13.1
183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
185 Correct documentation and missing rel-notes update for RTD.
188 2019 December 6; version 1.13.0
189 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191 Add ability to route messages based on the MEID in a message
192 combined with the message type/subscription-ID.
195 2019 November 14; version 1.11.1 (Amber)
196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198 Fix bug in payload reallocation function; correct length of
199 payload was not always copied.
202 2019 November 13; version 1.12.1
203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
205 New message type constants added to support A1.
208 2019 November 4; version 1.11.0 (Amber)
209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
211 Version bump to move away from the 1.10.* to distinguish
212 between release A and the trial.
215 2019 November 7; version 1.12.0
216 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
218 Version cut to support continued development for next release
219 preserving the 1.11.* versions for release 1 (Amber) and
223 2019 October 31; version 1.10.2
224 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
231 2019 October 21; version 1.10.1
232 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
234 Fix to prevent null message buffer from being returned by the
235 timeout receive function if the function is passed one to
239 2019 October 21; version 1.10.1
240 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
242 Add periodic dump of send count info to stderr.
245 2019 September 27; version 1.9.0
246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
248 Python bindings added receive all queued function and
249 corrected a unit test
252 2019 September 25; version 1.8.3
253 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
255 Correct application level test issue causing timing problems
256 during jenkins verification testing at command and merge
258 Handle the NNG connection shutdown status which may now be
259 generated when a connection throug a proxy is reset.
262 2019 September 25; version 1.8.2
263 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
265 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
268 2019 September 19; version 1.8.1
269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
271 Correct missing constant for wrappers.
274 2019 September 19; version 1.8.0
275 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
277 New message types added: RAN_CONNECTED, RAN_RESTARTED,
281 2019 September 17; version 1.7.0
282 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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).
290 2019 September 3; version 1.6.0
291 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
306 2019 August 26; version 1.4.0
307 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
309 New message types were added.
312 2019 August 16; version 1.3.0
313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
315 New mesage types added.
318 2019 August 13; version 1.2.0 (API change, non-breaking)
319 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321 The function rmr_get_xact() was added to proide a convenient
322 way to extract the transaction field from a message.
325 2019 August 8; version 1.1.0 (API change)
326 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
338 2019 August 6; version 1.0.45 (build changes)
339 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
341 Support for the Nanomsg transport library has been dropped.
342 The library librmr.* will no longer be included in packages.
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.
354 2019 August 6; version 1.0.44 (API change)
355 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
357 Added a new message type constant.
360 2019 July 15; Version 1.0.39 (bug fix)
361 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
363 Prevent unnecessary usleep in retry loop.
366 2019 July 12; Version 1.0.38 (API change)
367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
369 Added new message types to RIC_message_types.h.
372 2019 July 11; Version 1.0.37
373 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
376 librmr and librmr_nng - Add message buffer API function
377 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
382 --------------------------------------------------------------------------------------------
385 2020 February 29; Version 2.4.0
386 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
388 Add consolidated testing under CMake Add support binary for
389 health check (SI95 only)
392 2020 February 28; Version 2.3.6
393 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
395 Fix bug in Rt. Mgr comm which prevented table ID from being
396 sent on ack message (RIC-232).