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 January 24; verison 3.0.5
19 --------------------------------------------------------------------------------------------
21 Fix bug in SI95 with receive buffer allocation.
24 2020 January 23; verison 3.0.4
25 --------------------------------------------------------------------------------------------
27 Fix bug in SI95 causing excessive CPU usage on poll.
30 2020 January 22; verison 3.0.3
31 --------------------------------------------------------------------------------------------
33 Enable thread support for multiple receive threads.
36 2020 January 21; verison 3.0.2
37 --------------------------------------------------------------------------------------------
39 Fix bug in SI95 (missing reallocate payload function).
42 2020 January 20; verison 3.0.1
43 --------------------------------------------------------------------------------------------
45 Enable support for dynamic route table updates via RMR
49 2020 January 16; version 3.0.0
50 --------------------------------------------------------------------------------------------
52 Introduce support for SI95 transport library to replace NNG.
53 (RMR library versions will use leading odd numbers to avoid
54 tag collisions with the wrapper tags which will use even
58 2019 December 9; version 1.13.1
59 --------------------------------------------------------------------------------------------
61 Correct documentation and missing rel-notes update for RTD.
64 2019 December 6; version 1.13.0
65 --------------------------------------------------------------------------------------------
67 Add ability to route messages based on the MEID in a message
68 combined with the message type/subscription-ID.
72 2019 November 14; version 1.11.1 (Amber)
73 --------------------------------------------------------------------------------------------
75 Fix bug in payload reallocation function; correct length of
76 payload was not always copied.
79 2019 November 13; version 1.12.1
80 --------------------------------------------------------------------------------------------
82 New message type constants added to support A1.
85 2019 November 4; version 1.11.0 (Amber)
86 --------------------------------------------------------------------------------------------
88 Version bump to move away from the 1.10.* to distinguish
89 between release A and the trial.
92 2019 November 7; version 1.12.0
93 --------------------------------------------------------------------------------------------
95 Version cut to support continued development for next release
96 preserving the 1.11.* versions for release 1 (Amber) and
100 2019 October 31; version 1.10.2
101 --------------------------------------------------------------------------------------------
103 Provide the means to increase the payload size of a received
104 message without losing the data needed to use the
105 rmr_rts_msg() funciton.
108 2019 October 21; version 1.10.1
109 --------------------------------------------------------------------------------------------
111 Fix to prevent null message buffer from being returned by the
112 timeout receive function if the function is passed one to
116 2019 October 21; version 1.10.1
117 --------------------------------------------------------------------------------------------
119 Add periodic dump of send count info to stderr.
122 2019 September 27; version 1.9.0
123 --------------------------------------------------------------------------------------------
125 Python bindings added receive all queued function and
126 corrected a unit test
129 2019 September 25; version 1.8.3
130 --------------------------------------------------------------------------------------------
132 Correct application level test issue causing timing problems
133 during jenkins verification testing at command and merge
135 Handle the NNG connection shutdown status which may now be
136 generated when a connection throug a proxy is reset.
139 2019 September 25; version 1.8.2
140 --------------------------------------------------------------------------------------------
142 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
145 2019 September 19; version 1.8.1
146 --------------------------------------------------------------------------------------------
148 Correct missing constant for wrappers.
151 2019 September 19; version 1.8.0
152 --------------------------------------------------------------------------------------------
154 New message types added: RAN_CONNECTED, RAN_RESTARTED,
158 2019 September 17; version 1.7.0
159 --------------------------------------------------------------------------------------------
161 Initial connection mode now defaults to asynchronous. Set
162 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
163 invoked to revert to synchronous first TCP connections.
164 (Recovery connection attempts have always been asynchronous).
167 2019 September 3; version 1.6.0
168 --------------------------------------------------------------------------------------------
170 Fix bug in the rmr_rts_msg() function. If a return to sender
171 message failed, the source IP address was not correctly
172 adjusted and could cause the message to be "reflected" back
173 to the sender on a retry.
175 Added the ability to set the source "ID" via an environment
176 var (RMR_SRC_ID). When present in the environment, the string
177 will be placed in to the message header as the source and
178 thus be used by an application calling rmr_rts_smg() to
179 return a response to the sender. If this environment variable
180 is not present, the host name (original behaviour) is used.
183 2019 August 26; version 1.4.0
184 --------------------------------------------------------------------------------------------
186 New message types were added.
189 2019 August 16; version 1.3.0
190 --------------------------------------------------------------------------------------------
192 New mesage types added.
195 2019 August 13; version 1.2.0 (API change, non-breaking)
196 --------------------------------------------------------------------------------------------
198 The function rmr_get_xact() was added to proide a convenient
199 way to extract the transaction field from a message.
202 2019 August 8; version 1.1.0 (API change)
203 --------------------------------------------------------------------------------------------
205 This change should be backward compatable/non-breaking A new
206 field has been added to the message buffer (rmr_mbuf_t). This
207 field (tp_state) is used to communicate the errno value that
208 the transport mechanism might set during send and/or receive
209 operations. C programmes should continue to use errno
210 directly, but in some environments wrappers may not be able
211 to access errno and this provides the value to them. See the
212 rmr_alloc_msg manual page for more details.
215 2019 August 6; version 1.0.45 (build changes)
216 --------------------------------------------------------------------------------------------
218 Support for the Nanomsg transport library has been dropped.
219 The library librmr.* will no longer be included in packages.
221 Packages will install RMR libraries into the system preferred
222 target directory. On some systems this is /usr/local/lib and
223 on others it is /usr/local/lib64. The diretory is determined
224 by the sytem on which the package is built and NOT by the
225 system installing the package, so it's possible that the RMR
226 libraries end up in a strange location if the .deb or .rpm
227 file was generated on a Linux flavour that has a different
228 preference than the one where the package is installed.
231 2019 August 6; version 1.0.44 (API change)
232 --------------------------------------------------------------------------------------------
234 Added a new message type constant.
237 2019 July 15; Version 1.0.39 (bug fix)
238 --------------------------------------------------------------------------------------------
240 Prevent unnecessary usleep in retry loop.
243 2019 July 12; Version 1.0.38 (API change)
244 --------------------------------------------------------------------------------------------
246 Added new message types to RIC_message_types.h.
249 2019 July 11; Version 1.0.37
250 --------------------------------------------------------------------------------------------
253 librmr and librmr_nng - Add message buffer API function
254 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev