2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. SPDX-License-Identifier: CC-BY-4.0
4 .. CAUTION: this document is generated from source in doc/src/rtd.
5 .. To make changes edit the source and recompile the document.
6 .. Do NOT make changes directly to .rst or .md files.
10 ============================================================================================
12 The following is a list of release highlights for the core
13 RMR library. These are extracted directly from the CHANGES
14 file at the repo root; please refer to that file for a
15 completely up to date listing of API changes.
18 2020 March 9; version 3.5.0
19 --------------------------------------------------------------------------------------------
21 Added new wormhole send function: rmr_wh_call().
24 2020 March 6; version 3.4.0
25 --------------------------------------------------------------------------------------------
27 Add new wormhole state function: rmr_wh_state().
30 2020 March 5; Version 3.3.1
31 --------------------------------------------------------------------------------------------
33 Correct several "bugs" identified by automatic code analysis.
36 2020 March 4; Version 3.3.0
37 --------------------------------------------------------------------------------------------
39 Add SI95 based unit testing Health check support binary added
40 (reason for minor bump)
43 2020 February 29; Version 2.4.0
44 --------------------------------------------------------------------------------------------
46 Add consolidated testing under CMake Add support binary for
47 health check (SI95 only)
50 2020 February 28; Version 2.3.6
51 --------------------------------------------------------------------------------------------
53 Fix bug in Rt. Mgr comm which prevented table ID from being
54 sent on ack message (RIC-232).
57 2020 February 26; version 3.2.5
58 --------------------------------------------------------------------------------------------
60 Fix source address bug in SI95 receive/send funcitons. Fix
61 threading issues involving session disconnection in SI95
62 Remove unused SI95 status variable.
65 2020 February 24; version 3.2.4
66 --------------------------------------------------------------------------------------------
68 Fix meid bug (RIC-220) causing core dump.
71 2020 February 21; version 3.2.3
72 --------------------------------------------------------------------------------------------
74 Add meid routing support to the SI95 interface.
77 2020 February 20; version 3.2.2
78 --------------------------------------------------------------------------------------------
80 Fix receive thread related core dump (ring early unlock).
83 2020 February 19; version 3.2.1
84 --------------------------------------------------------------------------------------------
86 Added missing message types (E2-Setup)
89 2020 February 18; version 3.2.0
90 --------------------------------------------------------------------------------------------
92 Added support for new Route Manager and it's ability to
93 accept a request for table update.
96 2020 February 14; version 3.1.3
97 --------------------------------------------------------------------------------------------
99 Fix bug in SIsend which was causing a core dump in some cases
100 where the application attempted to send on a connection that
101 had disconnected. (RIC-207).
104 2020 February 6; version 3.1.2
105 --------------------------------------------------------------------------------------------
107 Fix disconnection detection bug in interface to SI95.
110 2020 January 31; verison 3.1.1
111 --------------------------------------------------------------------------------------------
113 Allow route table thread logging to be completely disabled
114 when logging is turned off.
117 2020 January 26; verison 3.1.0
118 --------------------------------------------------------------------------------------------
120 First step to allowing the user programme to control messages
121 written to standard error. Introduces the rmr_set_vlevel()
122 function, and related environment variable.
125 2020 January 24; verison 3.0.5
126 --------------------------------------------------------------------------------------------
128 Fix bug in SI95 with receive buffer allocation.
131 2020 January 23; verison 3.0.4
132 --------------------------------------------------------------------------------------------
134 Fix bug in SI95 causing excessive CPU usage on poll.
137 2020 January 22; verison 3.0.3
138 --------------------------------------------------------------------------------------------
140 Enable thread support for multiple receive threads.
143 2020 January 21; verison 3.0.2
144 --------------------------------------------------------------------------------------------
146 Fix bug in SI95 (missing reallocate payload function).
149 2020 January 20; verison 3.0.1
150 --------------------------------------------------------------------------------------------
152 Enable support for dynamic route table updates via RMR
156 2020 January 16; version 3.0.0
157 --------------------------------------------------------------------------------------------
159 Introduce support for SI95 transport library to replace NNG.
160 (RMR library versions will use leading odd numbers to avoid
161 tag collisions with the wrapper tags which will use even
165 2019 December 9; version 1.13.1
166 --------------------------------------------------------------------------------------------
168 Correct documentation and missing rel-notes update for RTD.
171 2019 December 6; version 1.13.0
172 --------------------------------------------------------------------------------------------
174 Add ability to route messages based on the MEID in a message
175 combined with the message type/subscription-ID.
179 2019 November 14; version 1.11.1 (Amber)
180 --------------------------------------------------------------------------------------------
182 Fix bug in payload reallocation function; correct length of
183 payload was not always copied.
186 2019 November 13; version 1.12.1
187 --------------------------------------------------------------------------------------------
189 New message type constants added to support A1.
192 2019 November 4; version 1.11.0 (Amber)
193 --------------------------------------------------------------------------------------------
195 Version bump to move away from the 1.10.* to distinguish
196 between release A and the trial.
199 2019 November 7; version 1.12.0
200 --------------------------------------------------------------------------------------------
202 Version cut to support continued development for next release
203 preserving the 1.11.* versions for release 1 (Amber) and
207 2019 October 31; version 1.10.2
208 --------------------------------------------------------------------------------------------
210 Provide the means to increase the payload size of a received
211 message without losing the data needed to use the
212 rmr_rts_msg() funciton.
215 2019 October 21; version 1.10.1
216 --------------------------------------------------------------------------------------------
218 Fix to prevent null message buffer from being returned by the
219 timeout receive function if the function is passed one to
223 2019 October 21; version 1.10.1
224 --------------------------------------------------------------------------------------------
226 Add periodic dump of send count info to stderr.
229 2019 September 27; version 1.9.0
230 --------------------------------------------------------------------------------------------
232 Python bindings added receive all queued function and
233 corrected a unit test
236 2019 September 25; version 1.8.3
237 --------------------------------------------------------------------------------------------
239 Correct application level test issue causing timing problems
240 during jenkins verification testing at command and merge
242 Handle the NNG connection shutdown status which may now be
243 generated when a connection throug a proxy is reset.
246 2019 September 25; version 1.8.2
247 --------------------------------------------------------------------------------------------
249 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
252 2019 September 19; version 1.8.1
253 --------------------------------------------------------------------------------------------
255 Correct missing constant for wrappers.
258 2019 September 19; version 1.8.0
259 --------------------------------------------------------------------------------------------
261 New message types added: RAN_CONNECTED, RAN_RESTARTED,
265 2019 September 17; version 1.7.0
266 --------------------------------------------------------------------------------------------
268 Initial connection mode now defaults to asynchronous. Set
269 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
270 invoked to revert to synchronous first TCP connections.
271 (Recovery connection attempts have always been asynchronous).
274 2019 September 3; version 1.6.0
275 --------------------------------------------------------------------------------------------
277 Fix bug in the rmr_rts_msg() function. If a return to sender
278 message failed, the source IP address was not correctly
279 adjusted and could cause the message to be "reflected" back
280 to the sender on a retry.
282 Added the ability to set the source "ID" via an environment
283 var (RMR_SRC_ID). When present in the environment, the string
284 will be placed in to the message header as the source and
285 thus be used by an application calling rmr_rts_smg() to
286 return a response to the sender. If this environment variable
287 is not present, the host name (original behaviour) is used.
290 2019 August 26; version 1.4.0
291 --------------------------------------------------------------------------------------------
293 New message types were added.
296 2019 August 16; version 1.3.0
297 --------------------------------------------------------------------------------------------
299 New mesage types added.
302 2019 August 13; version 1.2.0 (API change, non-breaking)
303 --------------------------------------------------------------------------------------------
305 The function rmr_get_xact() was added to proide a convenient
306 way to extract the transaction field from a message.
309 2019 August 8; version 1.1.0 (API change)
310 --------------------------------------------------------------------------------------------
312 This change should be backward compatable/non-breaking A new
313 field has been added to the message buffer (rmr_mbuf_t). This
314 field (tp_state) is used to communicate the errno value that
315 the transport mechanism might set during send and/or receive
316 operations. C programmes should continue to use errno
317 directly, but in some environments wrappers may not be able
318 to access errno and this provides the value to them. See the
319 rmr_alloc_msg manual page for more details.
322 2019 August 6; version 1.0.45 (build changes)
323 --------------------------------------------------------------------------------------------
325 Support for the Nanomsg transport library has been dropped.
326 The library librmr.* will no longer be included in packages.
328 Packages will install RMR libraries into the system preferred
329 target directory. On some systems this is /usr/local/lib and
330 on others it is /usr/local/lib64. The diretory is determined
331 by the sytem on which the package is built and NOT by the
332 system installing the package, so it's possible that the RMR
333 libraries end up in a strange location if the .deb or .rpm
334 file was generated on a Linux flavour that has a different
335 preference than the one where the package is installed.
338 2019 August 6; version 1.0.44 (API change)
339 --------------------------------------------------------------------------------------------
341 Added a new message type constant.
344 2019 July 15; Version 1.0.39 (bug fix)
345 --------------------------------------------------------------------------------------------
347 Prevent unnecessary usleep in retry loop.
350 2019 July 12; Version 1.0.38 (API change)
351 --------------------------------------------------------------------------------------------
353 Added new message types to RIC_message_types.h.
356 2019 July 11; Version 1.0.37
357 --------------------------------------------------------------------------------------------
360 librmr and librmr_nng - Add message buffer API function
361 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev