Fix possible nil pointer deref in interface check
[ric-plt/lib/rmr.git] / CHANGES_CORE.txt
1 # this file should contain ONLY the changes related to the
2 # core RMR code and doc.  Other change files exist for other
3 # things.
4
5 # API and build change  and fix summaries. Doc correctsions
6 # and/or changes are not mentioned here; see the commit messages.
7
8 2020 April 2; version 3.6.5
9         Correct potential nil pointer use when examining interfaces for
10         use as a listen target (RIC-307)
11
12 2020 April 1; version 3.6.4
13         Correct potential nil pointer use in the NNG interface (RIC-303)
14         Correct issue preventing CI build without a container
15
16 2020 March 30; version 3.6.3
17         Correct the max receive message size constant in rmr.h (RIC-301)
18
19 2020 March 23; version 3.6.2
20         Fix message initialisation bug when pulling a message from
21         the pool (RIC-295)
22
23 2020 March 19; version 3.6.1
24         Fix problem with RPM package install
25
26 2020 March 18; version 3.6.0
27         Add message types to support traffic steering
28
29 2020 March 16; version 3.5.2
30         Correct bug in the meid table parser that prevented the
31         ack/nack of meid tables (RIC-273)
32
33 2020 March 10; version 3.5.1
34         Add missing health check message types.
35
36 2020 March 9; version 3.5.0
37         Added new wormhole send function: rmr_wh_call().
38
39 2020 March 6; version 3.4.0
40         Add new wormhole state function: rmr_wh_state().
41
42 2020 March 5; Version 3.3.1
43         Correct several "bugs" identified by automatic code analysis.
44
45 2020 March 4; Version 3.3.0
46         Add SI95 based unit testing
47         Health check support binary added (reason for minor bump)
48
49 2020 February 26; version 3.2.5
50         Fix source address bug in SI95 receive/send funcitons.
51         Fix threading issues involving session disconnection in SI95
52         Remove unused SI95 status variable.
53
54 2020 February 24; version 3.2.4
55         Fix meid bug (RIC-220) causing core dump.
56
57 2020 February 21; version 3.2.3
58         Add meid routing support to the SI95 interface.
59
60 2020 February 20; version 3.2.2
61         Fix receive thread related core dump (ring early unlock).
62
63 2020 February 19; version 3.2.1
64         Added missing message types (E2-Setup)
65
66 2020 February 18; version 3.2.0
67         Added support for new Route Manager and it's ability to accept
68         a request for table update.
69
70 2020 February 14; version 3.1.3
71         Fix bug in SIsend which was causing a core dump in some cases
72         where the application attempted to send on a connection that
73         had disconnected. (RIC-207).
74
75 2020 February 6; version 3.1.2
76         Fix disconnection detection bug in interface to SI95.
77
78 2020 January 31; verison 3.1.1
79         Allow route table thread logging to be completely disabled
80         when logging is turned off.
81
82 2020 January 26; verison 3.1.0
83         First step to allowing the user programme to control messages
84         written to standard error. Introduces the rmr_set_vlevel()
85         function, and related environment variable.
86
87 2020 January 24; verison 3.0.5
88         Fix bug in SI95 with receive buffer allocation.
89
90 2020 January 23; verison 3.0.4
91         Fix bug in SI95 causing excessive CPU usage on poll.
92
93 2020 January 22; verison 3.0.3
94         Enable thread support for multiple receive threads.
95
96 2020 January 21; verison 3.0.2
97         Fix bug in SI95 (missing reallocate payload function).
98
99 2020 January 20; verison 3.0.1
100         Enable support for dynamic route table updates via RMR session.
101
102 2020 January 16; version 3.0.0
103         Introduce support for SI95 transport library to replace NNG.
104         (RMR library versions will use leading odd numbers to avoid tag collisions
105          with the wrapper tags which will use even numbers.)
106
107 2019 December 9; version 1.13.1
108         Correct documentation and missing rel-notes update for RTD.
109
110 2019 December 6; version 1.13.0
111         Add ability to route messages based on the MEID in a message combined
112         with the message type/subscription-ID.
113
114 2019 November 14; version 1.11.1 (Amber)
115         Fix bug in payload reallocation function; correct length of payload
116         was not always copied.
117
118 2019 November 13; version 1.12.1
119         New message type constants added to support A1.
120
121 2019 November 4; version 1.11.0 (Amber)
122         Version bump to move away from the 1.10.* to distinguish between
123         release A and the trial.
124
125 2019 November 7; version 1.12.0
126         Version cut to support continued development for next release
127         preserving the 1.11.* versions for release 1 (Amber) and
128         related fixes.
129
130 2019 October 31; version 1.10.2
131         Provide the means to increase the payload size of a received message
132         without losing the data needed to use the rmr_rts_msg() funciton.
133
134 2019 October 21; version 1.10.1
135         Fix to prevent null message buffer from being returned by the timeout
136         receive function if the function is passed one to reuse.
137
138 2019 October 21; version 1.10.1
139         Add periodic dump of send count info to stderr.
140
141 2019 September 27; version 1.9.0
142         Python bindings added receive all queued function and corrected a unit test
143
144 2019 September 25; version 1.8.3
145         Correct application level test issue causing timing problems during
146         jenkins verification testing at command and merge
147
148         Handle the NNG connection shutdown status which may now be
149         generated when a connection throug a proxy is reset.
150
151 2019 September 25; version 1.8.2
152         Correct bug in rmr_torcv_msg() when timeout set to zero (0).
153
154 2019 September 19; version 1.8.1
155         Correct missing constant for wrappers.
156
157 2019 September 19; version 1.8.0
158         New message types added:
159                 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
160
161 2019 September 17; version 1.7.0
162         Initial connection mode now defaults to asynchronous. Set RMR_ASYNC_CONN=0
163         in the environment before rmr_init() is invoked to revert to
164         synchronous first TCP connections. (Recovery connection attempts
165         have always been asynchronous).
166
167 2019 September 3; version 1.6.0
168         Fix bug in the rmr_rts_msg() function. If a return to sender message
169         failed, the source IP address was not correctly adjusted and could
170         cause the message to be "reflected" back to the sender on a retry.
171
172         Added the ability to set the source "ID" via an environment var
173         (RMR_SRC_ID).  When present in the environment, the string will
174         be placed in to the message header as the source and thus be used
175         by an application calling rmr_rts_smg() to return a response to
176         the sender.  If this environment variable is not present, the host
177         name (original behaviour) is used.
178
179 2019 August 26; version 1.4.0
180         New message types were added.
181
182 2019 August 16; version 1.3.0
183         New mesage types added.
184
185 2019 August 13; version 1.2.0 (API change, non-breaking)
186         The function rmr_get_xact() was added to proide a convenient
187         way to extract the transaction field from a message.
188
189 2019 August 8; version 1.1.0 (API change)
190         This change should be backward compatable/non-breaking
191         A new field has been added to the message buffer (rmr_mbuf_t).
192         This field (tp_state) is used to communicate the errno value
193         that the transport mechanism might set during send and/or
194         receive operations.  C programmes should continue to use
195         errno directly, but in some environments wrappers may not be
196         able to access errno and this provides the value to them.
197         See the rmr_alloc_msg manual page for more details.
198
199 2019 August 6; version 1.0.45 (build changes)
200         Support for the Nanomsg transport library has been dropped.
201                 The library librmr.* will no longer be included in packages.
202
203         Packages will install RMR libraries into the system preferred
204                 target directory. On some systems this is /usr/local/lib
205                 and on others it is /usr/local/lib64.  The diretory is
206                 determined by the sytem on which the package is built and
207                 NOT by the system installing the package, so it's possible
208                 that the RMR libraries end up in a strange location if the
209                 .deb or .rpm file was generated on a Linux flavour that
210                 has a different preference than the one where the package
211                 is installed.
212
213 2019 August 6; version 1.0.44 (API change)
214         Added a new message type constant.
215
216 2019 July 15; Version 1.0.39 (bug fix)
217         Prevent unnecessary usleep in retry loop.
218
219 2019 July 12; Version 1.0.38 (API change)
220         Added new message types to RIC_message_types.h.
221
222 2019 July 11; Version 1.0.37
223
224         librmr and librmr_nng
225                 - Add message buffer API function rmr_trace_ref()
226                   (see rmr_trace_ref.3 manual page in dev package).
227