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