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 20; version 3.8.1
34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 Add user guide which replaces the concatenation of man pages
40 2020 April 17; version 3.8.0
41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43 Add safe connect to avoid potential connect bug on Linux
46 Change debugging in route table collector to avoid possible
47 segment fault when in level 2 debug (RIC-335)
50 2020 April 15; version 3.7.4
51 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 Add missing message type to header file (RIC-334)
56 2020 April 14; version 3.7.3
57 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
59 Fix bug in rmr_call() when using SI95 (RIC-333)
62 2020 April 10; version 3.7.2
63 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65 Fix bug related to static route table only mode (RIC-331)
68 2020 April 9; version 3.7.1
69 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 The max length restriction for receiving messages when using
72 SI95 has been removed. The length supplied during
73 initialisation is used as the "normal maximum" and default
74 buffer allocation size, but messages arriving which are
75 larger are accepted. (RIC-309)
78 2020 April 7; version 3.7.0
79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81 The health check support programme was renamed to rmr_probe
85 2020 April 6; version 3.6.6
86 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88 Correct bug in SI95 address conversion module (RIC-327)
89 Correct bug in SI initialisation module
92 2020 April 2; version 3.6.5
93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95 Correct potential nil pointer use when examining interfaces
96 for use as a listen target (RIC-307)
99 2020 April 1; version 3.6.4
100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102 Correct potential nil pointer use in the NNG interface
103 (RIC-303) Correct issue preventing CI build without a
107 2020 March 30; version 3.6.3
108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110 Correct the max receive message size constant in rmr.h
114 2020 March 23; version 3.6.2
115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
117 Fix message initialisation bug when pulling a message from
121 2020 March 19; version 3.6.1
122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
124 Fix problem with RPM package install
127 2020 March 18; version 3.6.0
128 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130 Add message types to support traffic steering
133 2020 March 16; version 3.5.2
134 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136 Correct bug in the meid table parser that prevented the
137 ack/nack of meid tables (RIC-273)
140 2020 March 10; version 3.5.1
141 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143 Add missing health check message types.
146 2020 March 9; version 3.5.0
147 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149 Added new wormhole send function: rmr_wh_call().
152 2020 March 6; version 3.4.0
153 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
155 Add new wormhole state function: rmr_wh_state().
158 2020 March 5; Version 3.3.1
159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
161 Correct several "bugs" identified by automatic code analysis.
164 2020 March 4; Version 3.3.0
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
167 Add SI95 based unit testing Health check support binary added
168 (reason for minor bump)
171 2020 February 26; version 3.2.5
172 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174 Fix source address bug in SI95 receive/send funcitons. Fix
175 threading issues involving session disconnection in SI95
176 Remove unused SI95 status variable.
179 2020 February 24; version 3.2.4
180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
182 Fix meid bug (RIC-220) causing core dump.
185 2020 February 21; version 3.2.3
186 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
188 Add meid routing support to the SI95 interface.
191 2020 February 20; version 3.2.2
192 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
194 Fix receive thread related core dump (ring early unlock).
197 2020 February 19; version 3.2.1
198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200 Added missing message types (E2-Setup)
203 2020 February 18; version 3.2.0
204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
206 Added support for new Route Manager and it's ability to
207 accept a request for table update.
210 2020 February 14; version 3.1.3
211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213 Fix bug in SIsend which was causing a core dump in some cases
214 where the application attempted to send on a connection that
215 had disconnected. (RIC-207).
218 2020 February 6; version 3.1.2
219 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221 Fix disconnection detection bug in interface to SI95.
224 2020 January 31; verison 3.1.1
225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
227 Allow route table thread logging to be completely disabled
228 when logging is turned off.
231 2020 January 26; verison 3.1.0
232 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
234 First step to allowing the user programme to control messages
235 written to standard error. Introduces the rmr_set_vlevel()
236 function, and related environment variable.
239 2020 January 24; verison 3.0.5
240 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
242 Fix bug in SI95 with receive buffer allocation.
245 2020 January 23; verison 3.0.4
246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
248 Fix bug in SI95 causing excessive CPU usage on poll.
251 2020 January 22; verison 3.0.3
252 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
254 Enable thread support for multiple receive threads.
257 2020 January 21; verison 3.0.2
258 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
260 Fix bug in SI95 (missing reallocate payload function).
263 2020 January 20; verison 3.0.1
264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
266 Enable support for dynamic route table updates via RMR
270 2020 January 16; version 3.0.0
271 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
273 Introduce support for SI95 transport library to replace NNG.
274 (RMR library versions will use leading odd numbers to avoid
275 tag collisions with the wrapper tags which will use even
279 2019 December 9; version 1.13.1
280 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
282 Correct documentation and missing rel-notes update for RTD.
285 2019 December 6; version 1.13.0
286 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
288 Add ability to route messages based on the MEID in a message
289 combined with the message type/subscription-ID.
292 2019 November 14; version 1.11.1 (Amber)
293 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
295 Fix bug in payload reallocation function; correct length of
296 payload was not always copied.
299 2019 November 13; version 1.12.1
300 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
302 New message type constants added to support A1.
305 2019 November 4; version 1.11.0 (Amber)
306 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
308 Version bump to move away from the 1.10.* to distinguish
309 between release A and the trial.
312 2019 November 7; version 1.12.0
313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
315 Version cut to support continued development for next release
316 preserving the 1.11.* versions for release 1 (Amber) and
320 2019 October 31; version 1.10.2
321 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
323 Provide the means to increase the payload size of a received
324 message without losing the data needed to use the
325 rmr_rts_msg() funciton.
328 2019 October 21; version 1.10.1
329 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
331 Fix to prevent null message buffer from being returned by the
332 timeout receive function if the function is passed one to
336 2019 October 21; version 1.10.1
337 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
339 Add periodic dump of send count info to stderr.
342 2019 September 27; version 1.9.0
343 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
345 Python bindings added receive all queued function and
346 corrected a unit test
349 2019 September 25; version 1.8.3
350 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
352 Correct application level test issue causing timing problems
353 during jenkins verification testing at command and merge
355 Handle the NNG connection shutdown status which may now be
356 generated when a connection throug a proxy is reset.
359 2019 September 25; version 1.8.2
360 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
362 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
365 2019 September 19; version 1.8.1
366 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
368 Correct missing constant for wrappers.
371 2019 September 19; version 1.8.0
372 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
374 New message types added: RAN_CONNECTED, RAN_RESTARTED,
378 2019 September 17; version 1.7.0
379 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
381 Initial connection mode now defaults to asynchronous. Set
382 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
383 invoked to revert to synchronous first TCP connections.
384 (Recovery connection attempts have always been asynchronous).
387 2019 September 3; version 1.6.0
388 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
390 Fix bug in the rmr_rts_msg() function. If a return to sender
391 message failed, the source IP address was not correctly
392 adjusted and could cause the message to be "reflected" back
393 to the sender on a retry.
395 Added the ability to set the source "ID" via an environment
396 var (RMR_SRC_ID). When present in the environment, the string
397 will be placed in to the message header as the source and
398 thus be used by an application calling rmr_rts_smg() to
399 return a response to the sender. If this environment variable
400 is not present, the host name (original behaviour) is used.
403 2019 August 26; version 1.4.0
404 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
406 New message types were added.
409 2019 August 16; version 1.3.0
410 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
412 New mesage types added.
415 2019 August 13; version 1.2.0 (API change, non-breaking)
416 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
418 The function rmr_get_xact() was added to proide a convenient
419 way to extract the transaction field from a message.
422 2019 August 8; version 1.1.0 (API change)
423 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
425 This change should be backward compatable/non-breaking A new
426 field has been added to the message buffer (rmr_mbuf_t). This
427 field (tp_state) is used to communicate the errno value that
428 the transport mechanism might set during send and/or receive
429 operations. C programmes should continue to use errno
430 directly, but in some environments wrappers may not be able
431 to access errno and this provides the value to them. See the
432 rmr_alloc_msg manual page for more details.
435 2019 August 6; version 1.0.45 (build changes)
436 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
438 Support for the Nanomsg transport library has been dropped.
439 The library librmr.* will no longer be included in packages.
441 Packages will install RMR libraries into the system preferred
442 target directory. On some systems this is /usr/local/lib and
443 on others it is /usr/local/lib64. The diretory is determined
444 by the sytem on which the package is built and NOT by the
445 system installing the package, so it's possible that the RMR
446 libraries end up in a strange location if the .deb or .rpm
447 file was generated on a Linux flavour that has a different
448 preference than the one where the package is installed.
451 2019 August 6; version 1.0.44 (API change)
452 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
454 Added a new message type constant.
457 2019 July 15; Version 1.0.39 (bug fix)
458 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
460 Prevent unnecessary usleep in retry loop.
463 2019 July 12; Version 1.0.38 (API change)
464 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
466 Added new message types to RIC_message_types.h.
469 2019 July 11; Version 1.0.37
470 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
473 librmr and librmr_nng - Add message buffer API function
474 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
479 --------------------------------------------------------------------------------------------
482 2020 April 8; Version n/a
483 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
485 RMR Python moved to Python Xapp Framework
486 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
489 2020 February 29; Version 2.4.0
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
492 Add consolidated testing under CMake Add support binary for
493 health check (SI95 only)
496 2020 February 28; Version 2.3.6
497 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
499 Fix bug in Rt. Mgr comm which prevented table ID from being
500 sent on ack message (RIC-232).