Fix sonar flagged bugs
[ric-plt/lib/rmr.git] / docs / rel-notes.rst
1  
2  
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. 
8  
9  
10  
11 RMR Release Notes 
12 ============================================================================================ 
13  
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). 
20  
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 
27 appropriate. 
28  
29 Core RMR Changes 
30 -------------------------------------------------------------------------------------------- 
31  
32  
33 2020 April 28; version 4.0.3 
34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
35  
36 Fix sonar flagged bugs (RIC-78) 
37  
38  
39 2020 April 24; version 4.0.2 
40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
41  
42 Correct bug in SI95 transport header length validation 
43 (RIC-341) 
44  
45  
46 2020 April 22; version 4.0.1 
47 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
48  
49 Correct message type constant for Traffic Steering 
50 predication (RIC-342) 
51  
52  
53 2020 April 21; version 4.0.0 
54 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
55  
56 The NNG based libraries are no longer included in the RMR 
57 packages. This is considered a breaking change as NNG will 
58 not be supported by default. It is still possible to build 
59 with RMR-NNG libraries, but that is the exception. The API 
60 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only 
61 means that the underlying transport mechanism is limited only 
62 to SI95. 
63  
64 The rmr_rcv_specific() function has been deprecated as it was 
65 necessary only for NNG and Nanomsg support. Its use should be 
66 discontinued. 
67  
68  
69 2020 April 20; version 3.8.2 
70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
71  
72 Fix bug which was preventing an instance receiving dynamic 
73 route table updates. (RIC-336) 
74  
75  
76 2020 April 20; version 3.8.1 
77 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
78  
79 Add user guide which replaces the concatenation of man pages 
80 (RIC-328) 
81  
82  
83 2020 April 17; version 3.8.0 
84 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
85  
86 Add safe connect to avoid potential connect bug on Linux 
87 (RIC-332) 
88  
89 Change debugging in route table collector to avoid possible 
90 segment fault when in level 2 debug (RIC-335) 
91  
92  
93 2020 April 15; version 3.7.4 
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
95  
96 Add missing message type to header file (RIC-334) 
97  
98  
99 2020 April 14; version 3.7.3 
100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
101  
102 Fix bug in rmr_call() when using SI95 (RIC-333) 
103  
104  
105 2020 April 10; version 3.7.2 
106 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
107  
108 Fix bug related to static route table only mode (RIC-331) 
109  
110  
111 2020 April 9; version 3.7.1 
112 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
113  
114 The max length restriction for receiving messages when using 
115 SI95 has been removed. The length supplied during 
116 initialisation is used as the "normal maximum" and default 
117 buffer allocation size, but messages arriving which are 
118 larger are accepted. (RIC-309) 
119  
120  
121 2020 April 7; version 3.7.0 
122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
123  
124 The health check support programme was renamed to rmr_probe 
125 (RIC-308). 
126  
127  
128 2020 April 6; version 3.6.6 
129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
130  
131 Correct bug in SI95 address conversion module (RIC-327) 
132 Correct bug in SI initialisation module 
133  
134  
135 2020 April 2; version 3.6.5 
136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
137  
138 Correct potential nil pointer use when examining interfaces 
139 for use as a listen target (RIC-307) 
140  
141  
142 2020 April 1; version 3.6.4 
143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
144  
145 Correct potential nil pointer use in the NNG interface 
146 (RIC-303) Correct issue preventing CI build without a 
147 container 
148  
149  
150 2020 March 30; version 3.6.3 
151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
152  
153 Correct the max receive message size constant in rmr.h 
154 (RIC-301) 
155  
156  
157 2020 March 23; version 3.6.2 
158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
159  
160 Fix message initialisation bug when pulling a message from 
161 the pool (RIC-295) 
162  
163  
164 2020 March 19; version 3.6.1 
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
166  
167 Fix problem with RPM package install 
168  
169  
170 2020 March 18; version 3.6.0 
171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
172  
173 Add message types to support traffic steering 
174  
175  
176 2020 March 16; version 3.5.2 
177 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
178  
179 Correct bug in the meid table parser that prevented the 
180 ack/nack of meid tables (RIC-273) 
181  
182  
183 2020 March 10; version 3.5.1 
184 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
185  
186 Add missing health check message types. 
187  
188  
189 2020 March 9; version 3.5.0 
190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
191  
192 Added new wormhole send function: rmr_wh_call(). 
193  
194  
195 2020 March 6; version 3.4.0 
196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
197  
198 Add new wormhole state function: rmr_wh_state(). 
199  
200  
201 2020 March 5; Version 3.3.1 
202 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
203  
204 Correct several "bugs" identified by automatic code analysis. 
205  
206  
207 2020 March 4; Version 3.3.0 
208 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
209  
210 Add SI95 based unit testing Health check support binary added 
211 (reason for minor bump) 
212  
213  
214 2020 February 26; version 3.2.5 
215 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
216  
217 Fix source address bug in SI95 receive/send funcitons. Fix 
218 threading issues involving session disconnection in SI95 
219 Remove unused SI95 status variable. 
220  
221  
222 2020 February 24; version 3.2.4 
223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
224  
225 Fix meid bug (RIC-220) causing core dump. 
226  
227  
228 2020 February 21; version 3.2.3 
229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
230  
231 Add meid routing support to the SI95 interface. 
232  
233  
234 2020 February 20; version 3.2.2 
235 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
236  
237 Fix receive thread related core dump (ring early unlock). 
238  
239  
240 2020 February 19; version 3.2.1 
241 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
242  
243 Added missing message types (E2-Setup) 
244  
245  
246 2020 February 18; version 3.2.0 
247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
248  
249 Added support for new Route Manager and it's ability to 
250 accept a request for table update. 
251  
252  
253 2020 February 14; version 3.1.3 
254 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
255  
256 Fix bug in SIsend which was causing a core dump in some cases 
257 where the application attempted to send on a connection that 
258 had disconnected. (RIC-207). 
259  
260  
261 2020 February 6; version 3.1.2 
262 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
263  
264 Fix disconnection detection bug in interface to SI95. 
265  
266  
267 2020 January 31; verison 3.1.1 
268 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
269  
270 Allow route table thread logging to be completely disabled 
271 when logging is turned off. 
272  
273  
274 2020 January 26; verison 3.1.0 
275 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
276  
277 First step to allowing the user programme to control messages 
278 written to standard error. Introduces the rmr_set_vlevel() 
279 function, and related environment variable. 
280  
281  
282 2020 January 24; verison 3.0.5 
283 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
284  
285 Fix bug in SI95 with receive buffer allocation. 
286  
287  
288 2020 January 23; verison 3.0.4 
289 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
290  
291 Fix bug in SI95 causing excessive CPU usage on poll. 
292  
293  
294 2020 January 22; verison 3.0.3 
295 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
296  
297 Enable thread support for multiple receive threads. 
298  
299  
300 2020 January 21; verison 3.0.2 
301 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
302  
303 Fix bug in SI95 (missing reallocate payload function). 
304  
305  
306 2020 January 20; verison 3.0.1 
307 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
308  
309 Enable support for dynamic route table updates via RMR 
310 session. 
311  
312  
313 2020 January 16; version 3.0.0 
314 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
315  
316 Introduce support for SI95 transport library to replace NNG. 
317 (RMR library versions will use leading odd numbers to avoid 
318 tag collisions with the wrapper tags which will use even 
319 numbers.) 
320  
321  
322 2019 December 9; version 1.13.1 
323 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
324  
325 Correct documentation and missing rel-notes update for RTD. 
326  
327  
328 2019 December 6; version 1.13.0 
329 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
330  
331 Add ability to route messages based on the MEID in a message 
332 combined with the message type/subscription-ID. 
333  
334  
335 2019 November 14; version 1.11.1 (Amber) 
336 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
337  
338 Fix bug in payload reallocation function; correct length of 
339 payload was not always copied. 
340  
341  
342 2019 November 13; version 1.12.1 
343 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
344  
345 New message type constants added to support A1. 
346  
347  
348 2019 November 4; version 1.11.0 (Amber) 
349 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
350  
351 Version bump to move away from the 1.10.* to distinguish 
352 between release A and the trial. 
353  
354  
355 2019 November 7; version 1.12.0 
356 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
357  
358 Version cut to support continued development for next release 
359 preserving the 1.11.* versions for release 1 (Amber) and 
360 related fixes. 
361  
362  
363 2019 October 31; version 1.10.2 
364 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
365  
366 Provide the means to increase the payload size of a received 
367 message without losing the data needed to use the 
368 rmr_rts_msg() funciton. 
369  
370  
371 2019 October 21; version 1.10.1 
372 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
373  
374 Fix to prevent null message buffer from being returned by the 
375 timeout receive function if the function is passed one to 
376 reuse. 
377  
378  
379 2019 October 21; version 1.10.1 
380 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
381  
382 Add periodic dump of send count info to stderr. 
383  
384  
385 2019 September 27; version 1.9.0 
386 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
387  
388 Python bindings added receive all queued function and 
389 corrected a unit test 
390  
391  
392 2019 September 25; version 1.8.3 
393 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
394  
395 Correct application level test issue causing timing problems 
396 during jenkins verification testing at command and merge 
397  
398 Handle the NNG connection shutdown status which may now be 
399 generated when a connection throug a proxy is reset. 
400  
401  
402 2019 September 25; version 1.8.2 
403 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
404  
405 Correct bug in rmr_torcv_msg() when timeout set to zero (0). 
406  
407  
408 2019 September 19; version 1.8.1 
409 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
410  
411 Correct missing constant for wrappers. 
412  
413  
414 2019 September 19; version 1.8.0 
415 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
416  
417 New message types added: RAN_CONNECTED, RAN_RESTARTED, 
418 RAN_RECONFIGURED 
419  
420  
421 2019 September 17; version 1.7.0 
422 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
423  
424 Initial connection mode now defaults to asynchronous. Set 
425 RMR_ASYNC_CONN=0 in the environment before rmr_init() is 
426 invoked to revert to synchronous first TCP connections. 
427 (Recovery connection attempts have always been asynchronous). 
428  
429  
430 2019 September 3; version 1.6.0 
431 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
432  
433 Fix bug in the rmr_rts_msg() function. If a return to sender 
434 message failed, the source IP address was not correctly 
435 adjusted and could cause the message to be "reflected" back 
436 to the sender on a retry. 
437  
438 Added the ability to set the source "ID" via an environment 
439 var (RMR_SRC_ID). When present in the environment, the string 
440 will be placed in to the message header as the source and 
441 thus be used by an application calling rmr_rts_smg() to 
442 return a response to the sender. If this environment variable 
443 is not present, the host name (original behaviour) is used. 
444  
445  
446 2019 August 26; version 1.4.0 
447 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
448  
449 New message types were added. 
450  
451  
452 2019 August 16; version 1.3.0 
453 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
454  
455 New mesage types added. 
456  
457  
458 2019 August 13; version 1.2.0 (API change, non-breaking) 
459 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
460  
461 The function rmr_get_xact() was added to proide a convenient 
462 way to extract the transaction field from a message. 
463  
464  
465 2019 August 8; version 1.1.0 (API change) 
466 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
467  
468 This change should be backward compatable/non-breaking A new 
469 field has been added to the message buffer (rmr_mbuf_t). This 
470 field (tp_state) is used to communicate the errno value that 
471 the transport mechanism might set during send and/or receive 
472 operations. C programmes should continue to use errno 
473 directly, but in some environments wrappers may not be able 
474 to access errno and this provides the value to them. See the 
475 rmr_alloc_msg manual page for more details. 
476  
477  
478 2019 August 6; version 1.0.45 (build changes) 
479 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
480  
481 Support for the Nanomsg transport library has been dropped. 
482 The library librmr.* will no longer be included in packages. 
483  
484 Packages will install RMR libraries into the system preferred 
485 target directory. On some systems this is /usr/local/lib and 
486 on others it is /usr/local/lib64. The diretory is determined 
487 by the sytem on which the package is built and NOT by the 
488 system installing the package, so it's possible that the RMR 
489 libraries end up in a strange location if the .deb or .rpm 
490 file was generated on a Linux flavour that has a different 
491 preference than the one where the package is installed. 
492  
493  
494 2019 August 6; version 1.0.44 (API change) 
495 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
496  
497 Added a new message type constant. 
498  
499  
500 2019 July 15; Version 1.0.39 (bug fix) 
501 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
502  
503 Prevent unnecessary usleep in retry loop. 
504  
505  
506 2019 July 12; Version 1.0.38 (API change) 
507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
508  
509 Added new message types to RIC_message_types.h. 
510  
511  
512 2019 July 11; Version 1.0.37 
513 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
514  
515  
516 librmr and librmr_nng - Add message buffer API function 
517 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev 
518 package). 
519  
520  
521 Wrapper Changes 
522 -------------------------------------------------------------------------------------------- 
523  
524  
525 2020 April 8; Version n/a 
526 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
527  
528 RMR Python moved to Python Xapp Framework 
529 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py) 
530  
531  
532 2020 February 29; Version 2.4.0 
533 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
534  
535 Add consolidated testing under CMake Add support binary for 
536 health check (SI95 only) 
537  
538  
539 2020 February 28; Version 2.3.6 
540 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
541  
542 Fix bug in Rt. Mgr comm which prevented table ID from being 
543 sent on ack message (RIC-232).