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