3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
4 .. SPDX-License-Identifier: CC-BY-4.0
5 .. CAUTION: this document is generated from source in doc/src/rtd.
6 .. To make changes edit the source and recompile the document.
7 .. Do NOT make changes directly to .rst or .md files.
12 ============================================================================================
14 The following is a list of release highlights for the core
15 RMR library and wrappers which are housed in the same
16 repository. These are extracted directly from the
17 CHANGES_*.txt files at the repo root; please refer to those
18 files for a completely up to date listing of API changes (as
19 generated documents may lag).
21 The RMR repo houses two distinct release entities: the core
22 RMR package and the python wrapper package. To avoid naming
23 conflicts (tags mostly) The core package uses odd major
24 version numbers (e.g. 3.2.1) and the wrapper package uses
25 even major version numbers. The release notes are split into
26 two sections; please be sure to scroll to the section that is
30 --------------------------------------------------------------------------------------------
33 2020 April 10; version 3.7.2
34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 Fix bug related to static route table only mode (RIC-331)
39 2020 April 9; version 3.7.1
40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42 The max length restriction for receiving messages when using
43 SI95 has been removed. The length supplied during
44 initialisation is used as the "normal maximum" and default
45 buffer allocation size, but messages arriving which are
46 larger are accepted. (RIC-309)
49 2020 April 7; version 3.7.0
50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52 The health check support programme was renamed to rmr_probe
56 2020 April 6; version 3.6.6
57 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
59 Correct bug in SI95 address conversion module (RIC-327)
60 Correct bug in SI initialisation module
63 2020 April 2; version 3.6.5
64 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
66 Correct potential nil pointer use when examining interfaces
67 for use as a listen target (RIC-307)
70 2020 April 1; version 3.6.4
71 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 Correct potential nil pointer use in the NNG interface
74 (RIC-303) Correct issue preventing CI build without a
78 2020 March 30; version 3.6.3
79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81 Correct the max receive message size constant in rmr.h
85 2020 March 23; version 3.6.2
86 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88 Fix message initialisation bug when pulling a message from
92 2020 March 19; version 3.6.1
93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95 Fix problem with RPM package install
98 2020 March 18; version 3.6.0
99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101 Add message types to support traffic steering
104 2020 March 16; version 3.5.2
105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
107 Correct bug in the meid table parser that prevented the
108 ack/nack of meid tables (RIC-273)
111 2020 March 10; version 3.5.1
112 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114 Add missing health check message types.
117 2020 March 9; version 3.5.0
118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120 Added new wormhole send function: rmr_wh_call().
123 2020 March 6; version 3.4.0
124 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126 Add new wormhole state function: rmr_wh_state().
129 2020 March 5; Version 3.3.1
130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132 Correct several "bugs" identified by automatic code analysis.
135 2020 March 4; Version 3.3.0
136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138 Add SI95 based unit testing Health check support binary added
139 (reason for minor bump)
142 2020 February 26; version 3.2.5
143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145 Fix source address bug in SI95 receive/send funcitons. Fix
146 threading issues involving session disconnection in SI95
147 Remove unused SI95 status variable.
150 2020 February 24; version 3.2.4
151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153 Fix meid bug (RIC-220) causing core dump.
156 2020 February 21; version 3.2.3
157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159 Add meid routing support to the SI95 interface.
162 2020 February 20; version 3.2.2
163 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
165 Fix receive thread related core dump (ring early unlock).
168 2020 February 19; version 3.2.1
169 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171 Added missing message types (E2-Setup)
174 2020 February 18; version 3.2.0
175 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177 Added support for new Route Manager and it's ability to
178 accept a request for table update.
181 2020 February 14; version 3.1.3
182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
184 Fix bug in SIsend which was causing a core dump in some cases
185 where the application attempted to send on a connection that
186 had disconnected. (RIC-207).
189 2020 February 6; version 3.1.2
190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
192 Fix disconnection detection bug in interface to SI95.
195 2020 January 31; verison 3.1.1
196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198 Allow route table thread logging to be completely disabled
199 when logging is turned off.
202 2020 January 26; verison 3.1.0
203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
205 First step to allowing the user programme to control messages
206 written to standard error. Introduces the rmr_set_vlevel()
207 function, and related environment variable.
210 2020 January 24; verison 3.0.5
211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213 Fix bug in SI95 with receive buffer allocation.
216 2020 January 23; verison 3.0.4
217 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
219 Fix bug in SI95 causing excessive CPU usage on poll.
222 2020 January 22; verison 3.0.3
223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
225 Enable thread support for multiple receive threads.
228 2020 January 21; verison 3.0.2
229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
231 Fix bug in SI95 (missing reallocate payload function).
234 2020 January 20; verison 3.0.1
235 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
237 Enable support for dynamic route table updates via RMR
241 2020 January 16; version 3.0.0
242 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
244 Introduce support for SI95 transport library to replace NNG.
245 (RMR library versions will use leading odd numbers to avoid
246 tag collisions with the wrapper tags which will use even
250 2019 December 9; version 1.13.1
251 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
253 Correct documentation and missing rel-notes update for RTD.
256 2019 December 6; version 1.13.0
257 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
259 Add ability to route messages based on the MEID in a message
260 combined with the message type/subscription-ID.
263 2019 November 14; version 1.11.1 (Amber)
264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
266 Fix bug in payload reallocation function; correct length of
267 payload was not always copied.
270 2019 November 13; version 1.12.1
271 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
273 New message type constants added to support A1.
276 2019 November 4; version 1.11.0 (Amber)
277 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
279 Version bump to move away from the 1.10.* to distinguish
280 between release A and the trial.
283 2019 November 7; version 1.12.0
284 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
286 Version cut to support continued development for next release
287 preserving the 1.11.* versions for release 1 (Amber) and
291 2019 October 31; version 1.10.2
292 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
294 Provide the means to increase the payload size of a received
295 message without losing the data needed to use the
296 rmr_rts_msg() funciton.
299 2019 October 21; version 1.10.1
300 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
302 Fix to prevent null message buffer from being returned by the
303 timeout receive function if the function is passed one to
307 2019 October 21; version 1.10.1
308 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
310 Add periodic dump of send count info to stderr.
313 2019 September 27; version 1.9.0
314 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
316 Python bindings added receive all queued function and
317 corrected a unit test
320 2019 September 25; version 1.8.3
321 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
323 Correct application level test issue causing timing problems
324 during jenkins verification testing at command and merge
326 Handle the NNG connection shutdown status which may now be
327 generated when a connection throug a proxy is reset.
330 2019 September 25; version 1.8.2
331 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
333 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
336 2019 September 19; version 1.8.1
337 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
339 Correct missing constant for wrappers.
342 2019 September 19; version 1.8.0
343 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
345 New message types added: RAN_CONNECTED, RAN_RESTARTED,
349 2019 September 17; version 1.7.0
350 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
352 Initial connection mode now defaults to asynchronous. Set
353 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
354 invoked to revert to synchronous first TCP connections.
355 (Recovery connection attempts have always been asynchronous).
358 2019 September 3; version 1.6.0
359 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
361 Fix bug in the rmr_rts_msg() function. If a return to sender
362 message failed, the source IP address was not correctly
363 adjusted and could cause the message to be "reflected" back
364 to the sender on a retry.
366 Added the ability to set the source "ID" via an environment
367 var (RMR_SRC_ID). When present in the environment, the string
368 will be placed in to the message header as the source and
369 thus be used by an application calling rmr_rts_smg() to
370 return a response to the sender. If this environment variable
371 is not present, the host name (original behaviour) is used.
374 2019 August 26; version 1.4.0
375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
377 New message types were added.
380 2019 August 16; version 1.3.0
381 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
383 New mesage types added.
386 2019 August 13; version 1.2.0 (API change, non-breaking)
387 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
389 The function rmr_get_xact() was added to proide a convenient
390 way to extract the transaction field from a message.
393 2019 August 8; version 1.1.0 (API change)
394 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
396 This change should be backward compatable/non-breaking A new
397 field has been added to the message buffer (rmr_mbuf_t). This
398 field (tp_state) is used to communicate the errno value that
399 the transport mechanism might set during send and/or receive
400 operations. C programmes should continue to use errno
401 directly, but in some environments wrappers may not be able
402 to access errno and this provides the value to them. See the
403 rmr_alloc_msg manual page for more details.
406 2019 August 6; version 1.0.45 (build changes)
407 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
409 Support for the Nanomsg transport library has been dropped.
410 The library librmr.* will no longer be included in packages.
412 Packages will install RMR libraries into the system preferred
413 target directory. On some systems this is /usr/local/lib and
414 on others it is /usr/local/lib64. The diretory is determined
415 by the sytem on which the package is built and NOT by the
416 system installing the package, so it's possible that the RMR
417 libraries end up in a strange location if the .deb or .rpm
418 file was generated on a Linux flavour that has a different
419 preference than the one where the package is installed.
422 2019 August 6; version 1.0.44 (API change)
423 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
425 Added a new message type constant.
428 2019 July 15; Version 1.0.39 (bug fix)
429 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
431 Prevent unnecessary usleep in retry loop.
434 2019 July 12; Version 1.0.38 (API change)
435 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
437 Added new message types to RIC_message_types.h.
440 2019 July 11; Version 1.0.37
441 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
444 librmr and librmr_nng - Add message buffer API function
445 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
450 --------------------------------------------------------------------------------------------
453 2020 April 8; Version n/a
454 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
456 RMR Python moved to Python Xapp Framework
457 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
460 2020 February 29; Version 2.4.0
461 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
463 Add consolidated testing under CMake Add support binary for
464 health check (SI95 only)
467 2020 February 28; Version 2.3.6
468 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
470 Fix bug in Rt. Mgr comm which prevented table ID from being
471 sent on ack message (RIC-232).