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