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