1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. CAUTION: this document is generated from source in doc/src/rtd.
4 .. To make changes edit the source and recompile the document.
5 .. Do NOT make changes directly to .rst or .md files.
7 ============================================================================================
9 ============================================================================================
15 The following is a list of release highlights for the RMR
16 library. At one point in time the RMR repo also housed a
17 wrapper library with a separate version and release cycle.
18 This resulted in *leap frogging* versions for each package;
19 the RMR core library was assigned odd major numbers (e.g.
20 3.1.0). When the wrapper code was moved to a different repo
21 the need to leap frog versions ceased, and beginning with
22 version 4.0.0, the RMR versions should no longer skip.
25 2020 July 9; version 4.1.3
26 --------------------------
28 Allow RTS messages to be sent before the arrival of the
29 initial route table. Calls to RTS (heart beat responses)
30 prior to the initial route table load could cause a crash if
31 a framework blindly assumes that RTS is valid. (RIC-589)
35 2020 June 22; version 4.1.2
36 ---------------------------
38 Fix typo in RIC Message header file.
40 Add document for message type constants and the scripts which
45 2020 June 22; version 4.1.1
46 ---------------------------
48 Add new message types to RIC header file for
52 RAN_E2_RESET_REQ (12008)
53 RAN_E2_RESET_RESP (12009)
57 2020 June 18; version 4.1.0
58 ---------------------------
60 Bump version minor to move away from 4.0.* which will bump
61 for any patches applied back to bronze.
63 Add magic C++ goo to symtab header file allowing C++ xAPPs to
64 use the symbol table directly.
73 2020 May 06; version 4.0.5
74 --------------------------
76 Fix the bug in SI95 receive message management semaphore
77 count issue. (RIC-355)
81 2020 April 29; version 4.0.4
82 ----------------------------
84 Fix the traffic steering message type constants (again)
89 2020 April 28; version 4.0.3
90 ----------------------------
92 Fix sonar flagged bugs (RIC-78)
96 2020 April 24; version 4.0.2
97 ----------------------------
99 Correct bug in SI95 transport header length validation
104 2020 April 22; version 4.0.1
105 ----------------------------
107 Correct message type constant for Traffic Steering
108 predication (RIC-342)
112 2020 April 21; version 4.0.0
113 ----------------------------
115 The NNG based libraries are no longer included in the RMR
116 packages. This is considered a breaking change as NNG will
117 not be supported by default. It is still possible to build
118 with RMR-NNG libraries, but that is the exception. The API
119 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
120 means that the underlying transport mechanism is limited only
123 The rmr_rcv_specific() function has been deprecated as it was
124 necessary only for NNG and Nanomsg support. Its use should be
129 2020 April 20; version 3.8.2
130 ----------------------------
132 Fix bug which was preventing an instance receiving dynamic
133 route table updates. (RIC-336)
137 2020 April 20; version 3.8.1
138 ----------------------------
140 Add user guide which replaces the concatenation of man pages
145 2020 April 17; version 3.8.0
146 ----------------------------
148 Add safe connect to avoid potential connect bug on Linux
151 Change debugging in route table collector to avoid possible
152 segment fault when in level 2 debug (RIC-335)
156 2020 April 15; version 3.7.4
157 ----------------------------
159 Add missing message type to header file (RIC-334)
163 2020 April 14; version 3.7.3
164 ----------------------------
166 Fix bug in rmr_call() when using SI95 (RIC-333)
170 2020 April 10; version 3.7.2
171 ----------------------------
173 Fix bug related to static route table only mode (RIC-331)
177 2020 April 9; version 3.7.1
178 ---------------------------
180 The max length restriction for receiving messages when using
181 SI95 has been removed. The length supplied during
182 initialisation is used as the "normal maximum" and default
183 buffer allocation size, but messages arriving which are
184 larger are accepted. (RIC-309)
188 2020 April 7; version 3.7.0
189 ---------------------------
191 The health check support programme was renamed to rmr_probe
196 2020 April 6; version 3.6.6
197 ---------------------------
199 Correct bug in SI95 address conversion module (RIC-327)
200 Correct bug in SI initialisation module
204 2020 April 2; version 3.6.5
205 ---------------------------
207 Correct potential nil pointer use when examining interfaces
208 for use as a listen target (RIC-307)
212 2020 April 1; version 3.6.4
213 ---------------------------
215 Correct potential nil pointer use in the NNG interface
216 (RIC-303) Correct issue preventing CI build without a
221 2020 March 30; version 3.6.3
222 ----------------------------
224 Correct the max receive message size constant in rmr.h
229 2020 March 23; version 3.6.2
230 ----------------------------
232 Fix message initialisation bug when pulling a message from
237 2020 March 19; version 3.6.1
238 ----------------------------
240 Fix problem with RPM package install
244 2020 March 18; version 3.6.0
245 ----------------------------
247 Add message types to support traffic steering
251 2020 March 16; version 3.5.2
252 ----------------------------
254 Correct bug in the meid table parser that prevented the
255 ack/nack of meid tables (RIC-273)
259 2020 March 10; version 3.5.1
260 ----------------------------
262 Add missing health check message types.
266 2020 March 9; version 3.5.0
267 ---------------------------
269 Added new wormhole send function: rmr_wh_call().
273 2020 March 6; version 3.4.0
274 ---------------------------
276 Add new wormhole state function: rmr_wh_state().
280 2020 March 5; Version 3.3.1
281 ---------------------------
283 Correct several "bugs" identified by automatic code analysis.
287 2020 March 4; Version 3.3.0
288 ---------------------------
290 Add SI95 based unit testing Health check support binary added
291 (reason for minor bump)
295 2020 February 26; version 3.2.5
296 -------------------------------
298 Fix source address bug in SI95 receive/send funcitons. Fix
299 threading issues involving session disconnection in SI95
300 Remove unused SI95 status variable.
304 2020 February 24; version 3.2.4
305 -------------------------------
307 Fix meid bug (RIC-220) causing core dump.
311 2020 February 21; version 3.2.3
312 -------------------------------
314 Add meid routing support to the SI95 interface.
318 2020 February 20; version 3.2.2
319 -------------------------------
321 Fix receive thread related core dump (ring early unlock).
325 2020 February 19; version 3.2.1
326 -------------------------------
328 Added missing message types (E2-Setup)
332 2020 February 18; version 3.2.0
333 -------------------------------
335 Added support for new Route Manager and it's ability to
336 accept a request for table update.
340 2020 February 14; version 3.1.3
341 -------------------------------
343 Fix bug in SIsend which was causing a core dump in some cases
344 where the application attempted to send on a connection that
345 had disconnected. (RIC-207).
349 2020 February 6; version 3.1.2
350 ------------------------------
352 Fix disconnection detection bug in interface to SI95.
356 2020 January 31; verison 3.1.1
357 ------------------------------
359 Allow route table thread logging to be completely disabled
360 when logging is turned off.
364 2020 January 26; verison 3.1.0
365 ------------------------------
367 First step to allowing the user programme to control messages
368 written to standard error. Introduces the rmr_set_vlevel()
369 function, and related environment variable.
373 2020 January 24; verison 3.0.5
374 ------------------------------
376 Fix bug in SI95 with receive buffer allocation.
380 2020 January 23; verison 3.0.4
381 ------------------------------
383 Fix bug in SI95 causing excessive CPU usage on poll.
387 2020 January 22; verison 3.0.3
388 ------------------------------
390 Enable thread support for multiple receive threads.
394 2020 January 21; verison 3.0.2
395 ------------------------------
397 Fix bug in SI95 (missing reallocate payload function).
401 2020 January 20; verison 3.0.1
402 ------------------------------
404 Enable support for dynamic route table updates via RMR
409 2020 January 16; version 3.0.0
410 ------------------------------
412 Introduce support for SI95 transport library to replace NNG.
413 (RMR library versions will use leading odd numbers to avoid
414 tag collisions with the wrapper tags which will use even
419 2019 December 9; version 1.13.1
420 -------------------------------
422 Correct documentation and missing rel-notes update for RTD.
426 2019 December 6; version 1.13.0
427 -------------------------------
429 Add ability to route messages based on the MEID in a message
430 combined with the message type/subscription-ID.
439 2019 November 14; version 1.11.1
440 --------------------------------
442 Fix bug in payload reallocation function; correct length of
443 payload was not always copied.
447 2019 November 13; version 1.12.1
448 --------------------------------
450 New message type constants added to support A1.
454 2019 November 4; version 1.11.0
455 -------------------------------
457 Version bump to move away from the 1.10.* to distinguish
458 between release A and the trial.
462 2019 November 7; version 1.12.0
463 -------------------------------
465 Version cut to support continued development for next release
466 preserving the 1.11.* versions for release 1 (Amber) and
471 2019 October 31; version 1.10.2
472 -------------------------------
474 Provide the means to increase the payload size of a received
475 message without losing the data needed to use the
476 rmr_rts_msg() funciton.
480 2019 October 21; version 1.10.1
481 -------------------------------
483 Fix to prevent null message buffer from being returned by the
484 timeout receive function if the function is passed one to
489 2019 October 21; version 1.10.1
490 -------------------------------
492 Add periodic dump of send count info to stderr.
496 2019 September 27; version 1.9.0
497 --------------------------------
499 Python bindings added receive all queued function and
500 corrected a unit test
504 2019 September 25; version 1.8.3
505 --------------------------------
507 Correct application level test issue causing timing problems
508 during jenkins verification testing at command and merge
510 Handle the NNG connection shutdown status which may now be
511 generated when a connection throug a proxy is reset.
515 2019 September 25; version 1.8.2
516 --------------------------------
518 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
522 2019 September 19; version 1.8.1
523 --------------------------------
525 Correct missing constant for wrappers.
529 2019 September 19; version 1.8.0
530 --------------------------------
532 New message types added:
533 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
537 2019 September 17; version 1.7.0
538 --------------------------------
540 Initial connection mode now defaults to asynchronous. Set
541 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
542 invoked to revert to synchronous first TCP connections.
543 (Recovery connection attempts have always been asynchronous).
547 2019 September 3; version 1.6.0
548 -------------------------------
550 Fix bug in the rmr_rts_msg() function. If a return to sender
551 message failed, the source IP address was not correctly
552 adjusted and could cause the message to be "reflected" back
553 to the sender on a retry.
555 Added the ability to set the source "ID" via an environment
556 var (RMR_SRC_ID). When present in the environment, the string
557 will be placed in to the message header as the source and
558 thus be used by an application calling rmr_rts_smg() to
559 return a response to the sender. If this environment variable
560 is not present, the host name (original behaviour) is used.
564 2019 August 26; version 1.4.0
565 -----------------------------
567 New message types were added.
571 2019 August 16; version 1.3.0
572 -----------------------------
574 New mesage types added.
578 2019 August 13; version 1.2.0 (API change, non-breaking)
579 --------------------------------------------------------
581 The function rmr_get_xact() was added to proide a convenient
582 way to extract the transaction field from a message.
586 2019 August 8; version 1.1.0 (API change)
587 -----------------------------------------
589 This change should be backward compatable/non-breaking A new
590 field has been added to the message buffer (rmr_mbuf_t). This
591 field (tp_state) is used to communicate the errno value that
592 the transport mechanism might set during send and/or receive
593 operations. C programmes should continue to use errno
594 directly, but in some environments wrappers may not be able
595 to access errno and this provides the value to them. See the
596 rmr_alloc_msg manual page for more details.
600 2019 August 6; version 1.0.45 (build changes)
601 ---------------------------------------------
603 Support for the Nanomsg transport library has been dropped.
604 The library librmr.* will no longer be included in packages.
606 Packages will install RMR libraries into the system preferred
607 target directory. On some systems this is /usr/local/lib
608 and on others it is /usr/local/lib64. The diretory is
609 determined by the sytem on which the package is built and
610 NOT by the system installing the package, so it's possible
611 that the RMR libraries end up in a strange location if the
612 .deb or .rpm file was generated on a Linux flavour that
613 has a different preference than the one where the package
618 2019 August 6; version 1.0.44 (API change)
619 ------------------------------------------
621 Added a new message type constant.
625 2019 July 15; Version 1.0.39 (bug fix)
626 --------------------------------------
628 Prevent unnecessary usleep in retry loop.
632 2019 July 12; Version 1.0.38 (API change)
633 -----------------------------------------
635 Added new message types to RIC_message_types.h.
639 2019 July 11; Version 1.0.37
640 ----------------------------
643 librmr and librmr_nng
644 - Add message buffer API function rmr_trace_ref()
645 (see rmr_trace_ref.3 manual page in dev package).
649 2020 April 8; Version n/a
650 -------------------------
652 RMR Python moved to Python Xapp Framework
653 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
657 2020 February 29; Version 2.4.0
658 -------------------------------
660 Add consolidated testing under CMake Add support binary for
661 health check (SI95 only)
665 2020 February 28; Version 2.3.6
666 -------------------------------
668 Fix bug in Rt. Mgr comm which prevented table ID from being
669 sent on ack message (RIC-232).