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 17; version 3.8.0
34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 Add safe connect to avoid potential connect bug on Linux
39 Change debugging in route table collector to avoid possible
40 segment fault when in level 2 debug (RIC-335)
43 2020 April 15; version 3.7.4
44 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46 Add missing message type to header file (RIC-334)
49 2020 April 14; version 3.7.3
50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52 Fix bug in rmr_call() when using SI95 (RIC-333)
55 2020 April 10; version 3.7.2
56 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58 Fix bug related to static route table only mode (RIC-331)
61 2020 April 9; version 3.7.1
62 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
64 The max length restriction for receiving messages when using
65 SI95 has been removed. The length supplied during
66 initialisation is used as the "normal maximum" and default
67 buffer allocation size, but messages arriving which are
68 larger are accepted. (RIC-309)
71 2020 April 7; version 3.7.0
72 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74 The health check support programme was renamed to rmr_probe
78 2020 April 6; version 3.6.6
79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81 Correct bug in SI95 address conversion module (RIC-327)
82 Correct bug in SI initialisation module
85 2020 April 2; version 3.6.5
86 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88 Correct potential nil pointer use when examining interfaces
89 for use as a listen target (RIC-307)
92 2020 April 1; version 3.6.4
93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95 Correct potential nil pointer use in the NNG interface
96 (RIC-303) Correct issue preventing CI build without a
100 2020 March 30; version 3.6.3
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103 Correct the max receive message size constant in rmr.h
107 2020 March 23; version 3.6.2
108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110 Fix message initialisation bug when pulling a message from
114 2020 March 19; version 3.6.1
115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
117 Fix problem with RPM package install
120 2020 March 18; version 3.6.0
121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123 Add message types to support traffic steering
126 2020 March 16; version 3.5.2
127 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
129 Correct bug in the meid table parser that prevented the
130 ack/nack of meid tables (RIC-273)
133 2020 March 10; version 3.5.1
134 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136 Add missing health check message types.
139 2020 March 9; version 3.5.0
140 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
142 Added new wormhole send function: rmr_wh_call().
145 2020 March 6; version 3.4.0
146 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
148 Add new wormhole state function: rmr_wh_state().
151 2020 March 5; Version 3.3.1
152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154 Correct several "bugs" identified by automatic code analysis.
157 2020 March 4; Version 3.3.0
158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160 Add SI95 based unit testing Health check support binary added
161 (reason for minor bump)
164 2020 February 26; version 3.2.5
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
167 Fix source address bug in SI95 receive/send funcitons. Fix
168 threading issues involving session disconnection in SI95
169 Remove unused SI95 status variable.
172 2020 February 24; version 3.2.4
173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175 Fix meid bug (RIC-220) causing core dump.
178 2020 February 21; version 3.2.3
179 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181 Add meid routing support to the SI95 interface.
184 2020 February 20; version 3.2.2
185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187 Fix receive thread related core dump (ring early unlock).
190 2020 February 19; version 3.2.1
191 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193 Added missing message types (E2-Setup)
196 2020 February 18; version 3.2.0
197 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
199 Added support for new Route Manager and it's ability to
200 accept a request for table update.
203 2020 February 14; version 3.1.3
204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
206 Fix bug in SIsend which was causing a core dump in some cases
207 where the application attempted to send on a connection that
208 had disconnected. (RIC-207).
211 2020 February 6; version 3.1.2
212 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
214 Fix disconnection detection bug in interface to SI95.
217 2020 January 31; verison 3.1.1
218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
220 Allow route table thread logging to be completely disabled
221 when logging is turned off.
224 2020 January 26; verison 3.1.0
225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
227 First step to allowing the user programme to control messages
228 written to standard error. Introduces the rmr_set_vlevel()
229 function, and related environment variable.
232 2020 January 24; verison 3.0.5
233 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
235 Fix bug in SI95 with receive buffer allocation.
238 2020 January 23; verison 3.0.4
239 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
241 Fix bug in SI95 causing excessive CPU usage on poll.
244 2020 January 22; verison 3.0.3
245 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
247 Enable thread support for multiple receive threads.
250 2020 January 21; verison 3.0.2
251 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
253 Fix bug in SI95 (missing reallocate payload function).
256 2020 January 20; verison 3.0.1
257 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
259 Enable support for dynamic route table updates via RMR
263 2020 January 16; version 3.0.0
264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
266 Introduce support for SI95 transport library to replace NNG.
267 (RMR library versions will use leading odd numbers to avoid
268 tag collisions with the wrapper tags which will use even
272 2019 December 9; version 1.13.1
273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
275 Correct documentation and missing rel-notes update for RTD.
278 2019 December 6; version 1.13.0
279 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
281 Add ability to route messages based on the MEID in a message
282 combined with the message type/subscription-ID.
285 2019 November 14; version 1.11.1 (Amber)
286 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
288 Fix bug in payload reallocation function; correct length of
289 payload was not always copied.
292 2019 November 13; version 1.12.1
293 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
295 New message type constants added to support A1.
298 2019 November 4; version 1.11.0 (Amber)
299 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
301 Version bump to move away from the 1.10.* to distinguish
302 between release A and the trial.
305 2019 November 7; version 1.12.0
306 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
308 Version cut to support continued development for next release
309 preserving the 1.11.* versions for release 1 (Amber) and
313 2019 October 31; version 1.10.2
314 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
316 Provide the means to increase the payload size of a received
317 message without losing the data needed to use the
318 rmr_rts_msg() funciton.
321 2019 October 21; version 1.10.1
322 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
324 Fix to prevent null message buffer from being returned by the
325 timeout receive function if the function is passed one to
329 2019 October 21; version 1.10.1
330 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
332 Add periodic dump of send count info to stderr.
335 2019 September 27; version 1.9.0
336 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
338 Python bindings added receive all queued function and
339 corrected a unit test
342 2019 September 25; version 1.8.3
343 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
345 Correct application level test issue causing timing problems
346 during jenkins verification testing at command and merge
348 Handle the NNG connection shutdown status which may now be
349 generated when a connection throug a proxy is reset.
352 2019 September 25; version 1.8.2
353 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
355 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
358 2019 September 19; version 1.8.1
359 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
361 Correct missing constant for wrappers.
364 2019 September 19; version 1.8.0
365 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
367 New message types added: RAN_CONNECTED, RAN_RESTARTED,
371 2019 September 17; version 1.7.0
372 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
374 Initial connection mode now defaults to asynchronous. Set
375 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
376 invoked to revert to synchronous first TCP connections.
377 (Recovery connection attempts have always been asynchronous).
380 2019 September 3; version 1.6.0
381 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
383 Fix bug in the rmr_rts_msg() function. If a return to sender
384 message failed, the source IP address was not correctly
385 adjusted and could cause the message to be "reflected" back
386 to the sender on a retry.
388 Added the ability to set the source "ID" via an environment
389 var (RMR_SRC_ID). When present in the environment, the string
390 will be placed in to the message header as the source and
391 thus be used by an application calling rmr_rts_smg() to
392 return a response to the sender. If this environment variable
393 is not present, the host name (original behaviour) is used.
396 2019 August 26; version 1.4.0
397 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
399 New message types were added.
402 2019 August 16; version 1.3.0
403 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
405 New mesage types added.
408 2019 August 13; version 1.2.0 (API change, non-breaking)
409 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
411 The function rmr_get_xact() was added to proide a convenient
412 way to extract the transaction field from a message.
415 2019 August 8; version 1.1.0 (API change)
416 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
418 This change should be backward compatable/non-breaking A new
419 field has been added to the message buffer (rmr_mbuf_t). This
420 field (tp_state) is used to communicate the errno value that
421 the transport mechanism might set during send and/or receive
422 operations. C programmes should continue to use errno
423 directly, but in some environments wrappers may not be able
424 to access errno and this provides the value to them. See the
425 rmr_alloc_msg manual page for more details.
428 2019 August 6; version 1.0.45 (build changes)
429 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
431 Support for the Nanomsg transport library has been dropped.
432 The library librmr.* will no longer be included in packages.
434 Packages will install RMR libraries into the system preferred
435 target directory. On some systems this is /usr/local/lib and
436 on others it is /usr/local/lib64. The diretory is determined
437 by the sytem on which the package is built and NOT by the
438 system installing the package, so it's possible that the RMR
439 libraries end up in a strange location if the .deb or .rpm
440 file was generated on a Linux flavour that has a different
441 preference than the one where the package is installed.
444 2019 August 6; version 1.0.44 (API change)
445 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
447 Added a new message type constant.
450 2019 July 15; Version 1.0.39 (bug fix)
451 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
453 Prevent unnecessary usleep in retry loop.
456 2019 July 12; Version 1.0.38 (API change)
457 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
459 Added new message types to RIC_message_types.h.
462 2019 July 11; Version 1.0.37
463 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
466 librmr and librmr_nng - Add message buffer API function
467 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
472 --------------------------------------------------------------------------------------------
475 2020 April 8; Version n/a
476 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
478 RMR Python moved to Python Xapp Framework
479 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
482 2020 February 29; Version 2.4.0
483 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
485 Add consolidated testing under CMake Add support binary for
486 health check (SI95 only)
489 2020 February 28; Version 2.3.6
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
492 Fix bug in Rt. Mgr comm which prevented table ID from being
493 sent on ack message (RIC-232).