1 # this file should contain ONLY the changes related to the
2 # core RMR code and doc. Other change files exist for other
5 # API and build change and fix summaries. Doc correctsions
6 # and/or changes are not mentioned here; see the commit messages.
8 2020 September 15; Version 4.2.3
9 Correct arg processing bug in rmr_rpobe (RIC-645)
11 2020 August 4; Version 4.2.2
12 Correct bug in the rmr_probe support utility when -r option is used
13 on the command line (RIC-644)
15 2020 August 4; Version 4.2.1
16 Add additional environment variable dump if RMR_LOG_VLEVEL set to
19 2020 August 3; Version 4.2.0
20 Add support for the RMR_RTREQ_FREQ environment variable to control
21 the request frequency for a new route table (default 5s if not
24 2020 July 21; Version 4.1.4
25 Fix bug in SI95 -- possible use of pointer after free (RIC-626).
27 2020 July 9; version 4.1.3
28 Allow RTS messages to be sent before the arrival of the initial
29 route table. Calls to RTS (heart beat responses) prior to the
30 initial route table load could cause a crash if a framework
31 blindly assumes that RTS is valid. (RIC-589)
33 2020 June 22; version 4.1.2
34 Fix typo in RIC Message header file.
36 Add document for message type constants and the scripts
39 2020 June 22; version 4.1.1
40 Add new message types to RIC header file for
44 RAN_E2_RESET_REQ (12008)
45 RAN_E2_RESET_RESP (12009)
47 2020 June 18; version 4.1.0
48 Bump version minor to move away from 4.0.* which will bump for any
49 patches applied back to bronze.
51 Add magic C++ goo to symtab header file allowing C++ xAPPs to use
52 the symbol table directly.
54 2020 May 06; version 4.0.5
55 Fix the bug in SI95 receive message management semaphore count
58 2020 April 29; version 4.0.4
59 Fix the traffic steering message type constants (again) (RIC-342)
61 2020 April 28; version 4.0.3
62 Fix sonar flagged bugs (RIC-78)
64 2020 April 24; version 4.0.2
65 Correct bug in SI95 transport header length validation (RIC-341)
67 2020 April 22; version 4.0.1
68 Correct message type constant for Traffic Steering predication (RIC-342)
70 2020 April 21; version 4.0.0
71 The NNG based libraries are no longer included in the RMR packages.
72 This is considered a breaking change as NNG will not be supported by
73 default. It is still possible to build with RMR-NNG libraries, but
74 that is the exception. The API between 3.8.2 and 4.0.0 is the SAME.
75 Upgrading to 4.0.0 only means that the underlying transport mechanism
76 is limited only to SI95.
78 The rmr_rcv_specific() function has been deprecated as it was necessary
79 only for NNG and Nanomsg support. Its use should be discontinued.
81 2020 April 20; version 3.8.2
82 Fix bug which was preventing an instance receiving dynamic route
83 table updates. (RIC-336)
85 2020 April 20; version 3.8.1
86 Add user guide which replaces the concatenation of man pages (RIC-328)
88 2020 April 17; version 3.8.0
89 Add safe connect to avoid potential connect bug on Linux (RIC-332)
91 Change debugging in route table collector to avoid possible
92 segment fault when in level 2 debug (RIC-335)
94 2020 April 15; version 3.7.4
95 Add missing message type to header file (RIC-334)
97 2020 April 14; version 3.7.3
98 Fix bug in rmr_call() when using SI95 (RIC-333)
100 2020 April 10; version 3.7.2
101 Fix bug related to static route table only mode (RIC-331)
103 2020 April 9; version 3.7.1
104 The max length restriction for receiving messages when using SI95 has
105 been removed. The length supplied during initialisation is used as
106 the "normal maximum" and default buffer allocation size, but messages
107 arriving which are larger are accepted. (RIC-309)
109 2020 April 7; version 3.7.0
110 The health check support programme was renamed to rmr_probe (RIC-308).
112 2020 April 6; version 3.6.6
113 Correct bug in SI95 address conversion module (RIC-327)
114 Correct bug in SI initialisation module
116 2020 April 2; version 3.6.5
117 Correct potential nil pointer use when examining interfaces for
118 use as a listen target (RIC-307)
120 2020 April 1; version 3.6.4
121 Correct potential nil pointer use in the NNG interface (RIC-303)
122 Correct issue preventing CI build without a container
124 2020 March 30; version 3.6.3
125 Correct the max receive message size constant in rmr.h (RIC-301)
127 2020 March 23; version 3.6.2
128 Fix message initialisation bug when pulling a message from
131 2020 March 19; version 3.6.1
132 Fix problem with RPM package install
134 2020 March 18; version 3.6.0
135 Add message types to support traffic steering
137 2020 March 16; version 3.5.2
138 Correct bug in the meid table parser that prevented the
139 ack/nack of meid tables (RIC-273)
141 2020 March 10; version 3.5.1
142 Add missing health check message types.
144 2020 March 9; version 3.5.0
145 Added new wormhole send function: rmr_wh_call().
147 2020 March 6; version 3.4.0
148 Add new wormhole state function: rmr_wh_state().
150 2020 March 5; Version 3.3.1
151 Correct several "bugs" identified by automatic code analysis.
153 2020 March 4; Version 3.3.0
154 Add SI95 based unit testing
155 Health check support binary added (reason for minor bump)
157 2020 February 26; version 3.2.5
158 Fix source address bug in SI95 receive/send funcitons.
159 Fix threading issues involving session disconnection in SI95
160 Remove unused SI95 status variable.
162 2020 February 24; version 3.2.4
163 Fix meid bug (RIC-220) causing core dump.
165 2020 February 21; version 3.2.3
166 Add meid routing support to the SI95 interface.
168 2020 February 20; version 3.2.2
169 Fix receive thread related core dump (ring early unlock).
171 2020 February 19; version 3.2.1
172 Added missing message types (E2-Setup)
174 2020 February 18; version 3.2.0
175 Added support for new Route Manager and it's ability to accept
176 a request for table update.
178 2020 February 14; version 3.1.3
179 Fix bug in SIsend which was causing a core dump in some cases
180 where the application attempted to send on a connection that
181 had disconnected. (RIC-207).
183 2020 February 6; version 3.1.2
184 Fix disconnection detection bug in interface to SI95.
186 2020 January 31; verison 3.1.1
187 Allow route table thread logging to be completely disabled
188 when logging is turned off.
190 2020 January 26; verison 3.1.0
191 First step to allowing the user programme to control messages
192 written to standard error. Introduces the rmr_set_vlevel()
193 function, and related environment variable.
195 2020 January 24; verison 3.0.5
196 Fix bug in SI95 with receive buffer allocation.
198 2020 January 23; verison 3.0.4
199 Fix bug in SI95 causing excessive CPU usage on poll.
201 2020 January 22; verison 3.0.3
202 Enable thread support for multiple receive threads.
204 2020 January 21; verison 3.0.2
205 Fix bug in SI95 (missing reallocate payload function).
207 2020 January 20; verison 3.0.1
208 Enable support for dynamic route table updates via RMR session.
210 2020 January 16; version 3.0.0
211 Introduce support for SI95 transport library to replace NNG.
212 (RMR library versions will use leading odd numbers to avoid tag collisions
213 with the wrapper tags which will use even numbers.)
215 2019 December 9; version 1.13.1
216 Correct documentation and missing rel-notes update for RTD.
218 2019 December 6; version 1.13.0
219 Add ability to route messages based on the MEID in a message combined
220 with the message type/subscription-ID.
222 2019 November 14; version 1.11.1
223 Fix bug in payload reallocation function; correct length of payload
224 was not always copied.
226 2019 November 13; version 1.12.1
227 New message type constants added to support A1.
229 2019 November 4; version 1.11.0
230 Version bump to move away from the 1.10.* to distinguish between
231 release A and the trial.
233 2019 November 7; version 1.12.0
234 Version cut to support continued development for next release
235 preserving the 1.11.* versions for release 1 (Amber) and
238 2019 October 31; version 1.10.2
239 Provide the means to increase the payload size of a received message
240 without losing the data needed to use the rmr_rts_msg() funciton.
242 2019 October 21; version 1.10.1
243 Fix to prevent null message buffer from being returned by the timeout
244 receive function if the function is passed one to reuse.
246 2019 October 21; version 1.10.1
247 Add periodic dump of send count info to stderr.
249 2019 September 27; version 1.9.0
250 Python bindings added receive all queued function and corrected a unit test
252 2019 September 25; version 1.8.3
253 Correct application level test issue causing timing problems during
254 jenkins verification testing at command and merge
256 Handle the NNG connection shutdown status which may now be
257 generated when a connection throug a proxy is reset.
259 2019 September 25; version 1.8.2
260 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
262 2019 September 19; version 1.8.1
263 Correct missing constant for wrappers.
265 2019 September 19; version 1.8.0
266 New message types added:
267 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
269 2019 September 17; version 1.7.0
270 Initial connection mode now defaults to asynchronous. Set RMR_ASYNC_CONN=0
271 in the environment before rmr_init() is invoked to revert to
272 synchronous first TCP connections. (Recovery connection attempts
273 have always been asynchronous).
275 2019 September 3; version 1.6.0
276 Fix bug in the rmr_rts_msg() function. If a return to sender message
277 failed, the source IP address was not correctly adjusted and could
278 cause the message to be "reflected" back to the sender on a retry.
280 Added the ability to set the source "ID" via an environment var
281 (RMR_SRC_ID). When present in the environment, the string will
282 be placed in to the message header as the source and thus be used
283 by an application calling rmr_rts_smg() to return a response to
284 the sender. If this environment variable is not present, the host
285 name (original behaviour) is used.
287 2019 August 26; version 1.4.0
288 New message types were added.
290 2019 August 16; version 1.3.0
291 New mesage types added.
293 2019 August 13; version 1.2.0 (API change, non-breaking)
294 The function rmr_get_xact() was added to proide a convenient
295 way to extract the transaction field from a message.
297 2019 August 8; version 1.1.0 (API change)
298 This change should be backward compatable/non-breaking
299 A new field has been added to the message buffer (rmr_mbuf_t).
300 This field (tp_state) is used to communicate the errno value
301 that the transport mechanism might set during send and/or
302 receive operations. C programmes should continue to use
303 errno directly, but in some environments wrappers may not be
304 able to access errno and this provides the value to them.
305 See the rmr_alloc_msg manual page for more details.
307 2019 August 6; version 1.0.45 (build changes)
308 Support for the Nanomsg transport library has been dropped.
309 The library librmr.* will no longer be included in packages.
311 Packages will install RMR libraries into the system preferred
312 target directory. On some systems this is /usr/local/lib
313 and on others it is /usr/local/lib64. The diretory is
314 determined by the sytem on which the package is built and
315 NOT by the system installing the package, so it's possible
316 that the RMR libraries end up in a strange location if the
317 .deb or .rpm file was generated on a Linux flavour that
318 has a different preference than the one where the package
321 2019 August 6; version 1.0.44 (API change)
322 Added a new message type constant.
324 2019 July 15; Version 1.0.39 (bug fix)
325 Prevent unnecessary usleep in retry loop.
327 2019 July 12; Version 1.0.38 (API change)
328 Added new message types to RIC_message_types.h.
330 2019 July 11; Version 1.0.37
332 librmr and librmr_nng
333 - Add message buffer API function rmr_trace_ref()
334 (see rmr_trace_ref.3 manual page in dev package).