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