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 June 22; version 4.1.2
26 ---------------------------
28 Fix typo in RIC Message header file.
30 Add document for message type constants and the scripts which
35 2020 June 22; version 4.1.1
36 ---------------------------
38 Add new message types to RIC header file for
42 RAN_E2_RESET_REQ (12008)
43 RAN_E2_RESET_RESP (12009)
47 2020 June 18; version 4.1.0
48 ---------------------------
50 Bump version minor to move away from 4.0.* which will bump
51 for any patches applied back to bronze.
53 Add magic C++ goo to symtab header file allowing C++ xAPPs to
54 use the symbol table directly.
63 2020 May 06; version 4.0.5
64 --------------------------
66 Fix the bug in SI95 receive message management semaphore
67 count issue. (RIC-355)
71 2020 April 29; version 4.0.4
72 ----------------------------
74 Fix the traffic steering message type constants (again)
79 2020 April 28; version 4.0.3
80 ----------------------------
82 Fix sonar flagged bugs (RIC-78)
86 2020 April 24; version 4.0.2
87 ----------------------------
89 Correct bug in SI95 transport header length validation
94 2020 April 22; version 4.0.1
95 ----------------------------
97 Correct message type constant for Traffic Steering
102 2020 April 21; version 4.0.0
103 ----------------------------
105 The NNG based libraries are no longer included in the RMR
106 packages. This is considered a breaking change as NNG will
107 not be supported by default. It is still possible to build
108 with RMR-NNG libraries, but that is the exception. The API
109 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
110 means that the underlying transport mechanism is limited only
113 The rmr_rcv_specific() function has been deprecated as it was
114 necessary only for NNG and Nanomsg support. Its use should be
119 2020 April 20; version 3.8.2
120 ----------------------------
122 Fix bug which was preventing an instance receiving dynamic
123 route table updates. (RIC-336)
127 2020 April 20; version 3.8.1
128 ----------------------------
130 Add user guide which replaces the concatenation of man pages
135 2020 April 17; version 3.8.0
136 ----------------------------
138 Add safe connect to avoid potential connect bug on Linux
141 Change debugging in route table collector to avoid possible
142 segment fault when in level 2 debug (RIC-335)
146 2020 April 15; version 3.7.4
147 ----------------------------
149 Add missing message type to header file (RIC-334)
153 2020 April 14; version 3.7.3
154 ----------------------------
156 Fix bug in rmr_call() when using SI95 (RIC-333)
160 2020 April 10; version 3.7.2
161 ----------------------------
163 Fix bug related to static route table only mode (RIC-331)
167 2020 April 9; version 3.7.1
168 ---------------------------
170 The max length restriction for receiving messages when using
171 SI95 has been removed. The length supplied during
172 initialisation is used as the "normal maximum" and default
173 buffer allocation size, but messages arriving which are
174 larger are accepted. (RIC-309)
178 2020 April 7; version 3.7.0
179 ---------------------------
181 The health check support programme was renamed to rmr_probe
186 2020 April 6; version 3.6.6
187 ---------------------------
189 Correct bug in SI95 address conversion module (RIC-327)
190 Correct bug in SI initialisation module
194 2020 April 2; version 3.6.5
195 ---------------------------
197 Correct potential nil pointer use when examining interfaces
198 for use as a listen target (RIC-307)
202 2020 April 1; version 3.6.4
203 ---------------------------
205 Correct potential nil pointer use in the NNG interface
206 (RIC-303) Correct issue preventing CI build without a
211 2020 March 30; version 3.6.3
212 ----------------------------
214 Correct the max receive message size constant in rmr.h
219 2020 March 23; version 3.6.2
220 ----------------------------
222 Fix message initialisation bug when pulling a message from
227 2020 March 19; version 3.6.1
228 ----------------------------
230 Fix problem with RPM package install
234 2020 March 18; version 3.6.0
235 ----------------------------
237 Add message types to support traffic steering
241 2020 March 16; version 3.5.2
242 ----------------------------
244 Correct bug in the meid table parser that prevented the
245 ack/nack of meid tables (RIC-273)
249 2020 March 10; version 3.5.1
250 ----------------------------
252 Add missing health check message types.
256 2020 March 9; version 3.5.0
257 ---------------------------
259 Added new wormhole send function: rmr_wh_call().
263 2020 March 6; version 3.4.0
264 ---------------------------
266 Add new wormhole state function: rmr_wh_state().
270 2020 March 5; Version 3.3.1
271 ---------------------------
273 Correct several "bugs" identified by automatic code analysis.
277 2020 March 4; Version 3.3.0
278 ---------------------------
280 Add SI95 based unit testing Health check support binary added
281 (reason for minor bump)
285 2020 February 26; version 3.2.5
286 -------------------------------
288 Fix source address bug in SI95 receive/send funcitons. Fix
289 threading issues involving session disconnection in SI95
290 Remove unused SI95 status variable.
294 2020 February 24; version 3.2.4
295 -------------------------------
297 Fix meid bug (RIC-220) causing core dump.
301 2020 February 21; version 3.2.3
302 -------------------------------
304 Add meid routing support to the SI95 interface.
308 2020 February 20; version 3.2.2
309 -------------------------------
311 Fix receive thread related core dump (ring early unlock).
315 2020 February 19; version 3.2.1
316 -------------------------------
318 Added missing message types (E2-Setup)
322 2020 February 18; version 3.2.0
323 -------------------------------
325 Added support for new Route Manager and it's ability to
326 accept a request for table update.
330 2020 February 14; version 3.1.3
331 -------------------------------
333 Fix bug in SIsend which was causing a core dump in some cases
334 where the application attempted to send on a connection that
335 had disconnected. (RIC-207).
339 2020 February 6; version 3.1.2
340 ------------------------------
342 Fix disconnection detection bug in interface to SI95.
346 2020 January 31; verison 3.1.1
347 ------------------------------
349 Allow route table thread logging to be completely disabled
350 when logging is turned off.
354 2020 January 26; verison 3.1.0
355 ------------------------------
357 First step to allowing the user programme to control messages
358 written to standard error. Introduces the rmr_set_vlevel()
359 function, and related environment variable.
363 2020 January 24; verison 3.0.5
364 ------------------------------
366 Fix bug in SI95 with receive buffer allocation.
370 2020 January 23; verison 3.0.4
371 ------------------------------
373 Fix bug in SI95 causing excessive CPU usage on poll.
377 2020 January 22; verison 3.0.3
378 ------------------------------
380 Enable thread support for multiple receive threads.
384 2020 January 21; verison 3.0.2
385 ------------------------------
387 Fix bug in SI95 (missing reallocate payload function).
391 2020 January 20; verison 3.0.1
392 ------------------------------
394 Enable support for dynamic route table updates via RMR
399 2020 January 16; version 3.0.0
400 ------------------------------
402 Introduce support for SI95 transport library to replace NNG.
403 (RMR library versions will use leading odd numbers to avoid
404 tag collisions with the wrapper tags which will use even
409 2019 December 9; version 1.13.1
410 -------------------------------
412 Correct documentation and missing rel-notes update for RTD.
416 2019 December 6; version 1.13.0
417 -------------------------------
419 Add ability to route messages based on the MEID in a message
420 combined with the message type/subscription-ID.
429 2019 November 14; version 1.11.1
430 --------------------------------
432 Fix bug in payload reallocation function; correct length of
433 payload was not always copied.
437 2019 November 13; version 1.12.1
438 --------------------------------
440 New message type constants added to support A1.
444 2019 November 4; version 1.11.0
445 -------------------------------
447 Version bump to move away from the 1.10.* to distinguish
448 between release A and the trial.
452 2019 November 7; version 1.12.0
453 -------------------------------
455 Version cut to support continued development for next release
456 preserving the 1.11.* versions for release 1 (Amber) and
461 2019 October 31; version 1.10.2
462 -------------------------------
464 Provide the means to increase the payload size of a received
465 message without losing the data needed to use the
466 rmr_rts_msg() funciton.
470 2019 October 21; version 1.10.1
471 -------------------------------
473 Fix to prevent null message buffer from being returned by the
474 timeout receive function if the function is passed one to
479 2019 October 21; version 1.10.1
480 -------------------------------
482 Add periodic dump of send count info to stderr.
486 2019 September 27; version 1.9.0
487 --------------------------------
489 Python bindings added receive all queued function and
490 corrected a unit test
494 2019 September 25; version 1.8.3
495 --------------------------------
497 Correct application level test issue causing timing problems
498 during jenkins verification testing at command and merge
500 Handle the NNG connection shutdown status which may now be
501 generated when a connection throug a proxy is reset.
505 2019 September 25; version 1.8.2
506 --------------------------------
508 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
512 2019 September 19; version 1.8.1
513 --------------------------------
515 Correct missing constant for wrappers.
519 2019 September 19; version 1.8.0
520 --------------------------------
522 New message types added:
523 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
527 2019 September 17; version 1.7.0
528 --------------------------------
530 Initial connection mode now defaults to asynchronous. Set
531 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
532 invoked to revert to synchronous first TCP connections.
533 (Recovery connection attempts have always been asynchronous).
537 2019 September 3; version 1.6.0
538 -------------------------------
540 Fix bug in the rmr_rts_msg() function. If a return to sender
541 message failed, the source IP address was not correctly
542 adjusted and could cause the message to be "reflected" back
543 to the sender on a retry.
545 Added the ability to set the source "ID" via an environment
546 var (RMR_SRC_ID). When present in the environment, the string
547 will be placed in to the message header as the source and
548 thus be used by an application calling rmr_rts_smg() to
549 return a response to the sender. If this environment variable
550 is not present, the host name (original behaviour) is used.
554 2019 August 26; version 1.4.0
555 -----------------------------
557 New message types were added.
561 2019 August 16; version 1.3.0
562 -----------------------------
564 New mesage types added.
568 2019 August 13; version 1.2.0 (API change, non-breaking)
569 --------------------------------------------------------
571 The function rmr_get_xact() was added to proide a convenient
572 way to extract the transaction field from a message.
576 2019 August 8; version 1.1.0 (API change)
577 -----------------------------------------
579 This change should be backward compatable/non-breaking A new
580 field has been added to the message buffer (rmr_mbuf_t). This
581 field (tp_state) is used to communicate the errno value that
582 the transport mechanism might set during send and/or receive
583 operations. C programmes should continue to use errno
584 directly, but in some environments wrappers may not be able
585 to access errno and this provides the value to them. See the
586 rmr_alloc_msg manual page for more details.
590 2019 August 6; version 1.0.45 (build changes)
591 ---------------------------------------------
593 Support for the Nanomsg transport library has been dropped.
594 The library librmr.* will no longer be included in packages.
596 Packages will install RMR libraries into the system preferred
597 target directory. On some systems this is /usr/local/lib
598 and on others it is /usr/local/lib64. The diretory is
599 determined by the sytem on which the package is built and
600 NOT by the system installing the package, so it's possible
601 that the RMR libraries end up in a strange location if the
602 .deb or .rpm file was generated on a Linux flavour that
603 has a different preference than the one where the package
608 2019 August 6; version 1.0.44 (API change)
609 ------------------------------------------
611 Added a new message type constant.
615 2019 July 15; Version 1.0.39 (bug fix)
616 --------------------------------------
618 Prevent unnecessary usleep in retry loop.
622 2019 July 12; Version 1.0.38 (API change)
623 -----------------------------------------
625 Added new message types to RIC_message_types.h.
629 2019 July 11; Version 1.0.37
630 ----------------------------
633 librmr and librmr_nng
634 - Add message buffer API function rmr_trace_ref()
635 (see rmr_trace_ref.3 manual page in dev package).
639 2020 April 8; Version n/a
640 -------------------------
642 RMR Python moved to Python Xapp Framework
643 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
647 2020 February 29; Version 2.4.0
648 -------------------------------
650 Add consolidated testing under CMake Add support binary for
651 health check (SI95 only)
655 2020 February 28; Version 2.3.6
656 -------------------------------
658 Fix bug in Rt. Mgr comm which prevented table ID from being
659 sent on ack message (RIC-232).