Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / ric-plt / lib / rmr / a1575dacc478b945ea63f5d0cc3db3d66dcb5983 / . / docs / rel-notes.rst
blob: a9b2ab78beb92143814e6c0a9ca0a07cd6a19d82 [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 Danielsa1575da2020-01-24 16:00:11 -0500[diff] [blame^]182020 January 24; verison 3.0.5
19--------------------------------------------------------------------------------------------
20
21Fix bug in SI95 with receive buffer allocation.
22
23
242020 January 23; verison 3.0.4
25--------------------------------------------------------------------------------------------
26
27Fix bug in SI95 causing excessive CPU usage on poll.
28
29
302020 January 22; verison 3.0.3
31--------------------------------------------------------------------------------------------
32
33Enable thread support for multiple receive threads.
34
35
362020 January 21; verison 3.0.2
37--------------------------------------------------------------------------------------------
38
39Fix bug in SI95 (missing reallocate payload function).
40
41
422020 January 20; verison 3.0.1
43--------------------------------------------------------------------------------------------
44
45Enable support for dynamic route table updates via RMR
46session.
47
48
492020 January 16; version 3.0.0
50--------------------------------------------------------------------------------------------
51
52Introduce support for SI95 transport library to replace NNG.
53(RMR library versions will use leading odd numbers to avoid
54tag collisions with the wrapper tags which will use even
55numbers.)
56
57
E. Scott Daniels190665f2019-12-09 09:05:22 -0500[diff] [blame]582019 December 9; version 1.13.1
59--------------------------------------------------------------------------------------------
60
61Correct documentation and missing rel-notes update for RTD.
62
63
642019 December 6; version 1.13.0
65--------------------------------------------------------------------------------------------
66
67Add ability to route messages based on the MEID in a message
68combined with the message type/subscription-ID.
69
70
71
722019 November 14; version 1.11.1 (Amber)
E. Scott Danielsde63b292019-11-14 16:03:51 -0500[diff] [blame]73--------------------------------------------------------------------------------------------
74
75Fix bug in payload reallocation function; correct length of
76payload was not always copied.
77
78
E. Scott Daniels190665f2019-12-09 09:05:22 -0500[diff] [blame]792019 November 13; version 1.12.1
80--------------------------------------------------------------------------------------------
81
82New message type constants added to support A1.
83
84
852019 November 4; version 1.11.0 (Amber)
E. Scott Danielsde63b292019-11-14 16:03:51 -0500[diff] [blame]86--------------------------------------------------------------------------------------------
87
88Version bump to move away from the 1.10.* to distinguish
89between release A and the trial.
90
91
E. Scott Daniels190665f2019-12-09 09:05:22 -0500[diff] [blame]922019 November 7; version 1.12.0
93--------------------------------------------------------------------------------------------
94
95Version cut to support continued development for next release
96preserving the 1.11.* versions for release 1 (Amber) and
97related fixes.
98
99
E. Scott Daniels392168d2019-11-06 15:12:38 -0500[diff] [blame]1002019 October 31; version 1.10.2
101--------------------------------------------------------------------------------------------
102
103Provide the means to increase the payload size of a received
104message without losing the data needed to use the
105rmr_rts_msg() funciton.
106
107
1082019 October 21; version 1.10.1
109--------------------------------------------------------------------------------------------
110
111Fix to prevent null message buffer from being returned by the
112timeout receive function if the function is passed one to
113reuse.
114
115
1162019 October 21; version 1.10.1
117--------------------------------------------------------------------------------------------
118
119Add periodic dump of send count info to stderr.
120
121
1222019 September 27; version 1.9.0
123--------------------------------------------------------------------------------------------
124
125Python bindings added receive all queued function and
126corrected a unit test
127
128
1292019 September 25; version 1.8.3
130--------------------------------------------------------------------------------------------
131
132Correct application level test issue causing timing problems
133during jenkins verification testing at command and merge
134
135Handle the NNG connection shutdown status which may now be
136generated when a connection throug a proxy is reset.
137
138
1392019 September 25; version 1.8.2
140--------------------------------------------------------------------------------------------
141
142Correct bug in rmr_torcv_msg() when timeout set to zero (0).
143
144
1452019 September 19; version 1.8.1
146--------------------------------------------------------------------------------------------
147
148Correct missing constant for wrappers.
149
E. Scott Danielsde63b292019-11-14 16:03:51 -0500[diff] [blame]150
E. Scott Daniels392168d2019-11-06 15:12:38 -0500[diff] [blame]1512019 September 19; version 1.8.0
152--------------------------------------------------------------------------------------------
153
154New message types added: RAN_CONNECTED, RAN_RESTARTED,
155RAN_RECONFIGURED
156
157
1582019 September 17; version 1.7.0
159--------------------------------------------------------------------------------------------
160
161Initial connection mode now defaults to asynchronous. Set
162RMR_ASYNC_CONN=0 in the environment before rmr_init() is
163invoked to revert to synchronous first TCP connections.
164(Recovery connection attempts have always been asynchronous).
165
166
1672019 September 3; version 1.6.0
168--------------------------------------------------------------------------------------------
169
170Fix bug in the rmr_rts_msg() function. If a return to sender
171message failed, the source IP address was not correctly
172adjusted and could cause the message to be "reflected" back
173to the sender on a retry.
174
175Added the ability to set the source "ID" via an environment
176var (RMR_SRC_ID). When present in the environment, the string
177will be placed in to the message header as the source and
178thus be used by an application calling rmr_rts_smg() to
179return a response to the sender. If this environment variable
180is not present, the host name (original behaviour) is used.
181
182
1832019 August 26; version 1.4.0
184--------------------------------------------------------------------------------------------
185
186New message types were added.
187
188
1892019 August 16; version 1.3.0
190--------------------------------------------------------------------------------------------
191
192New mesage types added.
193
194
1952019 August 13; version 1.2.0 (API change, non-breaking)
196--------------------------------------------------------------------------------------------
197
198The function rmr_get_xact() was added to proide a convenient
199way to extract the transaction field from a message.
200
201
2022019 August 8; version 1.1.0 (API change)
203--------------------------------------------------------------------------------------------
204
205This change should be backward compatable/non-breaking A new
206field has been added to the message buffer (rmr_mbuf_t). This
207field (tp_state) is used to communicate the errno value that
208the transport mechanism might set during send and/or receive
209operations. C programmes should continue to use errno
210directly, but in some environments wrappers may not be able
211to access errno and this provides the value to them. See the
212rmr_alloc_msg manual page for more details.
213
E. Scott Danielsde63b292019-11-14 16:03:51 -0500[diff] [blame]214
E. Scott Daniels392168d2019-11-06 15:12:38 -0500[diff] [blame]2152019 August 6; version 1.0.45 (build changes)
216--------------------------------------------------------------------------------------------
217
218Support for the Nanomsg transport library has been dropped.
219The library librmr.* will no longer be included in packages.
220
221Packages will install RMR libraries into the system preferred
222target directory. On some systems this is /usr/local/lib and
223on others it is /usr/local/lib64. The diretory is determined
224by the sytem on which the package is built and NOT by the
225system installing the package, so it's possible that the RMR
226libraries end up in a strange location if the .deb or .rpm
227file was generated on a Linux flavour that has a different
228preference than the one where the package is installed.
229
230
2312019 August 6; version 1.0.44 (API change)
232--------------------------------------------------------------------------------------------
233
234Added a new message type constant.
235
236
2372019 July 15; Version 1.0.39 (bug fix)
238--------------------------------------------------------------------------------------------
239
240Prevent unnecessary usleep in retry loop.
241
242
2432019 July 12; Version 1.0.38 (API change)
244--------------------------------------------------------------------------------------------
245
246Added new message types to RIC_message_types.h.
247
248
2492019 July 11; Version 1.0.37
250--------------------------------------------------------------------------------------------
251
252
253librmr and librmr_nng - Add message buffer API function
254rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
255package).
256