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