Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / ric-plt / lib / rmr / 8633a0b93e26b619a367de0614437ef2eb4a0b37 / . / docs / rel-notes.rst
blob: a1bf81697fd178099cddeba966afb90110f4cfb3 [file] [log] [blame]
E. Scott Daniels392168d2019-11-06 15:12:38 -0500[diff] [blame]1
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.
7
8
9RMR Release Notes
10============================================================================================
11
12The following is a list of release highlights for the core
13RMR library. These are extracted directly from the CHANGES
14file at the repo root; please refer to that file for a
15completely up to date listing of API changes.
16
17
E. Scott Daniels8633a0b2020-03-09 13:57:39 -0400[diff] [blame^]182020 March 9; version 3.5.0
19--------------------------------------------------------------------------------------------
20
21Added new wormhole send function: rmr_wh_call().
22
23
E. Scott Daniels4d1f9bf2020-03-06 12:29:28 -0500[diff] [blame]242020 March 6; version 3.4.0
25--------------------------------------------------------------------------------------------
26
27Add new wormhole state function: rmr_wh_state().
28
29
302020 March 5; Version 3.3.1
31--------------------------------------------------------------------------------------------
32
33Correct several "bugs" identified by automatic code analysis.
34
35
362020 March 4; Version 3.3.0
37--------------------------------------------------------------------------------------------
38
39Add SI95 based unit testing Health check support binary added
40(reason for minor bump)
41
42
432020 February 29; Version 2.4.0
44--------------------------------------------------------------------------------------------
45
46Add consolidated testing under CMake Add support binary for
47health check (SI95 only)
48
49
502020 February 28; Version 2.3.6
51--------------------------------------------------------------------------------------------
52
53Fix bug in Rt. Mgr comm which prevented table ID from being
54sent on ack message (RIC-232).
55
56
572020 February 26; version 3.2.5
58--------------------------------------------------------------------------------------------
59
60Fix source address bug in SI95 receive/send funcitons. Fix
61threading issues involving session disconnection in SI95
62Remove unused SI95 status variable.
63
64
652020 February 24; version 3.2.4
66--------------------------------------------------------------------------------------------
67
68Fix meid bug (RIC-220) causing core dump.
69
70
712020 February 21; version 3.2.3
72--------------------------------------------------------------------------------------------
73
74Add meid routing support to the SI95 interface.
75
76
772020 February 20; version 3.2.2
78--------------------------------------------------------------------------------------------
79
80Fix receive thread related core dump (ring early unlock).
81
82
832020 February 19; version 3.2.1
84--------------------------------------------------------------------------------------------
85
86Added missing message types (E2-Setup)
87
88
892020 February 18; version 3.2.0
90--------------------------------------------------------------------------------------------
91
92Added support for new Route Manager and it's ability to
93accept a request for table update.
94
95
962020 February 14; version 3.1.3
97--------------------------------------------------------------------------------------------
98
99Fix bug in SIsend which was causing a core dump in some cases
100where the application attempted to send on a connection that
101had disconnected. (RIC-207).
102
103
1042020 February 6; version 3.1.2
105--------------------------------------------------------------------------------------------
106
107Fix disconnection detection bug in interface to SI95.
108
109
1102020 January 31; verison 3.1.1
111--------------------------------------------------------------------------------------------
112
113Allow route table thread logging to be completely disabled
114when logging is turned off.
115
116
1172020 January 26; verison 3.1.0
118--------------------------------------------------------------------------------------------
119
120First step to allowing the user programme to control messages
121written to standard error. Introduces the rmr_set_vlevel()
122function, and related environment variable.
123
124
E. Scott Danielsa1575da2020-01-24 16:00:11 -0500[diff] [blame]1252020 January 24; verison 3.0.5
126--------------------------------------------------------------------------------------------
127
128Fix bug in SI95 with receive buffer allocation.
129
130
1312020 January 23; verison 3.0.4
132--------------------------------------------------------------------------------------------
133
134Fix bug in SI95 causing excessive CPU usage on poll.
135
136
1372020 January 22; verison 3.0.3
138--------------------------------------------------------------------------------------------
139
140Enable thread support for multiple receive threads.
141
142
1432020 January 21; verison 3.0.2
144--------------------------------------------------------------------------------------------
145
146Fix bug in SI95 (missing reallocate payload function).
147
148
1492020 January 20; verison 3.0.1
150--------------------------------------------------------------------------------------------
151
152Enable support for dynamic route table updates via RMR
153session.
154
155
1562020 January 16; version 3.0.0
157--------------------------------------------------------------------------------------------
158
159Introduce support for SI95 transport library to replace NNG.
160(RMR library versions will use leading odd numbers to avoid
161tag collisions with the wrapper tags which will use even
162numbers.)
163
164
E. Scott Daniels190665f2019-12-09 09:05:22 -0500[diff] [blame]1652019 December 9; version 1.13.1
166--------------------------------------------------------------------------------------------
167
168Correct documentation and missing rel-notes update for RTD.
169
170
1712019 December 6; version 1.13.0
172--------------------------------------------------------------------------------------------
173
174Add ability to route messages based on the MEID in a message
175combined with the message type/subscription-ID.
176
177
178
1792019 November 14; version 1.11.1 (Amber)
E. Scott Danielsde63b292019-11-14 16:03:51 -0500[diff] [blame]180--------------------------------------------------------------------------------------------
181
182Fix bug in payload reallocation function; correct length of
183payload was not always copied.
184
185
E. Scott Daniels190665f2019-12-09 09:05:22 -0500[diff] [blame]1862019 November 13; version 1.12.1
187--------------------------------------------------------------------------------------------
188
189New message type constants added to support A1.
190
191
1922019 November 4; version 1.11.0 (Amber)
E. Scott Danielsde63b292019-11-14 16:03:51 -0500[diff] [blame]193--------------------------------------------------------------------------------------------
194
195Version bump to move away from the 1.10.* to distinguish
196between release A and the trial.
197
198
E. Scott Daniels190665f2019-12-09 09:05:22 -0500[diff] [blame]1992019 November 7; version 1.12.0
200--------------------------------------------------------------------------------------------
201
202Version cut to support continued development for next release
203preserving the 1.11.* versions for release 1 (Amber) and
204related fixes.
205
206
E. Scott Daniels392168d2019-11-06 15:12:38 -0500[diff] [blame]2072019 October 31; version 1.10.2
208--------------------------------------------------------------------------------------------
209
210Provide the means to increase the payload size of a received
211message without losing the data needed to use the
212rmr_rts_msg() funciton.
213
214
2152019 October 21; version 1.10.1
216--------------------------------------------------------------------------------------------
217
218Fix to prevent null message buffer from being returned by the
219timeout receive function if the function is passed one to
220reuse.
221
222
2232019 October 21; version 1.10.1
224--------------------------------------------------------------------------------------------
225
226Add periodic dump of send count info to stderr.
227
228
2292019 September 27; version 1.9.0
230--------------------------------------------------------------------------------------------
231
232Python bindings added receive all queued function and
233corrected a unit test
234
235
2362019 September 25; version 1.8.3
237--------------------------------------------------------------------------------------------
238
239Correct application level test issue causing timing problems
240during jenkins verification testing at command and merge
241
242Handle the NNG connection shutdown status which may now be
243generated when a connection throug a proxy is reset.
244
245
2462019 September 25; version 1.8.2
247--------------------------------------------------------------------------------------------
248
249Correct bug in rmr_torcv_msg() when timeout set to zero (0).
250
251
2522019 September 19; version 1.8.1
253--------------------------------------------------------------------------------------------
254
255Correct missing constant for wrappers.
256
E. Scott Danielsde63b292019-11-14 16:03:51 -0500[diff] [blame]257
E. Scott Daniels392168d2019-11-06 15:12:38 -0500[diff] [blame]2582019 September 19; version 1.8.0
259--------------------------------------------------------------------------------------------
260
261New message types added: RAN_CONNECTED, RAN_RESTARTED,
262RAN_RECONFIGURED
263
264
2652019 September 17; version 1.7.0
266--------------------------------------------------------------------------------------------
267
268Initial connection mode now defaults to asynchronous. Set
269RMR_ASYNC_CONN=0 in the environment before rmr_init() is
270invoked to revert to synchronous first TCP connections.
271(Recovery connection attempts have always been asynchronous).
272
273
2742019 September 3; version 1.6.0
275--------------------------------------------------------------------------------------------
276
277Fix bug in the rmr_rts_msg() function. If a return to sender
278message failed, the source IP address was not correctly
279adjusted and could cause the message to be "reflected" back
280to the sender on a retry.
281
282Added the ability to set the source "ID" via an environment
283var (RMR_SRC_ID). When present in the environment, the string
284will be placed in to the message header as the source and
285thus be used by an application calling rmr_rts_smg() to
286return a response to the sender. If this environment variable
287is not present, the host name (original behaviour) is used.
288
289
2902019 August 26; version 1.4.0
291--------------------------------------------------------------------------------------------
292
293New message types were added.
294
295
2962019 August 16; version 1.3.0
297--------------------------------------------------------------------------------------------
298
299New mesage types added.
300
301
3022019 August 13; version 1.2.0 (API change, non-breaking)
303--------------------------------------------------------------------------------------------
304
305The function rmr_get_xact() was added to proide a convenient
306way to extract the transaction field from a message.
307
308
3092019 August 8; version 1.1.0 (API change)
310--------------------------------------------------------------------------------------------
311
312This change should be backward compatable/non-breaking A new
313field has been added to the message buffer (rmr_mbuf_t). This
314field (tp_state) is used to communicate the errno value that
315the transport mechanism might set during send and/or receive
316operations. C programmes should continue to use errno
317directly, but in some environments wrappers may not be able
318to access errno and this provides the value to them. See the
319rmr_alloc_msg manual page for more details.
320
E. Scott Danielsde63b292019-11-14 16:03:51 -0500[diff] [blame]321
E. Scott Daniels392168d2019-11-06 15:12:38 -0500[diff] [blame]3222019 August 6; version 1.0.45 (build changes)
323--------------------------------------------------------------------------------------------
324
325Support for the Nanomsg transport library has been dropped.
326The library librmr.* will no longer be included in packages.
327
328Packages will install RMR libraries into the system preferred
329target directory. On some systems this is /usr/local/lib and
330on others it is /usr/local/lib64. The diretory is determined
331by the sytem on which the package is built and NOT by the
332system installing the package, so it's possible that the RMR
333libraries end up in a strange location if the .deb or .rpm
334file was generated on a Linux flavour that has a different
335preference than the one where the package is installed.
336
337
3382019 August 6; version 1.0.44 (API change)
339--------------------------------------------------------------------------------------------
340
341Added a new message type constant.
342
343
3442019 July 15; Version 1.0.39 (bug fix)
345--------------------------------------------------------------------------------------------
346
347Prevent unnecessary usleep in retry loop.
348
349
3502019 July 12; Version 1.0.38 (API change)
351--------------------------------------------------------------------------------------------
352
353Added new message types to RIC_message_types.h.
354
355
3562019 July 11; Version 1.0.37
357--------------------------------------------------------------------------------------------
358
359
360librmr and librmr_nng - Add message buffer API function
361rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
362package).
363