blob: 95007812f3e8279ca5170b4b04dc0cae2a913910 [file] [log] [blame]
E. Scott Danielsd9615252020-04-01 14:01:02 -04001# this file should contain ONLY the changes related to the
E. Scott Daniels52f4bc92020-03-13 11:10:34 -04002# core RMR code and doc. Other change files exist for other
3# things.
E. Scott Daniels7d1b7b02019-10-22 16:23:36 -04004
E. Scott Daniels52f4bc92020-03-13 11:10:34 -04005# API and build change and fix summaries. Doc correctsions
6# and/or changes are not mentioned here; see the commit messages.
E. Scott Danielsa7610c62019-07-11 10:24:01 -04007
E. Scott Danielse15b1382020-04-14 15:55:13 -040082020 April 14; version 3.7.3
9 Fix bug in rmr_call() when using SI95 (RIC-333)
10
E. Scott Daniels2d9d6782020-04-10 12:11:30 -0400112020 April 10; version 3.7.2
12 Fix bug related to static route table only mode (RIC-331)
13
E. Scott Danielsc113b082020-04-08 15:44:40 -0400142020 April 9; version 3.7.1
15 The max length restriction for receiving messages when using SI95 has
16 been removed. The length supplied during initialisation is used as
17 the "normal maximum" and default buffer allocation size, but messages
18 arriving which are larger are accepted. (RIC-309)
19
E. Scott Danielsb021c0d2020-04-03 10:14:44 -0400202020 April 7; version 3.7.0
21 The health check support programme was renamed to rmr_probe (RIC-308).
22
E. Scott Daniels0a584582020-04-06 16:42:32 -0400232020 April 6; version 3.6.6
24 Correct bug in SI95 address conversion module (RIC-327)
25 Correct bug in SI initialisation module
26
E. Scott Danielsd9615252020-04-01 14:01:02 -0400272020 April 2; version 3.6.5
28 Correct potential nil pointer use when examining interfaces for
29 use as a listen target (RIC-307)
30
E. Scott Daniels17398002020-04-01 12:39:47 -0400312020 April 1; version 3.6.4
32 Correct potential nil pointer use in the NNG interface (RIC-303)
33 Correct issue preventing CI build without a container
34
E. Scott Daniels338fe5e2020-03-30 11:05:45 -0400352020 March 30; version 3.6.3
36 Correct the max receive message size constant in rmr.h (RIC-301)
37
E. Scott Daniels116d0f52020-03-23 14:37:16 -0400382020 March 23; version 3.6.2
E. Scott Danielsd9615252020-04-01 14:01:02 -040039 Fix message initialisation bug when pulling a message from
E. Scott Daniels116d0f52020-03-23 14:37:16 -040040 the pool (RIC-295)
41
E. Scott Daniels0949fab2020-03-18 23:50:57 -0400422020 March 19; version 3.6.1
43 Fix problem with RPM package install
44
E. Scott Danielsfe9b5bd2020-03-18 08:41:07 -0400452020 March 18; version 3.6.0
46 Add message types to support traffic steering
47
E. Scott Daniels33a2b862020-03-16 13:12:59 -0400482020 March 16; version 3.5.2
49 Correct bug in the meid table parser that prevented the
50 ack/nack of meid tables (RIC-273)
51
E. Scott Daniels7edb9ff2020-03-10 08:28:37 -0400522020 March 10; version 3.5.1
53 Add missing health check message types.
E. Scott Danielsd9615252020-04-01 14:01:02 -040054
E. Scott Daniels8633a0b2020-03-09 13:57:39 -0400552020 March 9; version 3.5.0
56 Added new wormhole send function: rmr_wh_call().
57
E. Scott Daniels4d1f9bf2020-03-06 12:29:28 -0500582020 March 6; version 3.4.0
59 Add new wormhole state function: rmr_wh_state().
60
E. Scott Daniels6926c662020-03-06 09:13:06 -0500612020 March 5; Version 3.3.1
62 Correct several "bugs" identified by automatic code analysis.
63
642020 March 4; Version 3.3.0
65 Add SI95 based unit testing
66 Health check support binary added (reason for minor bump)
67
E. Scott Daniels20829ec2020-02-26 14:28:54 -0500682020 February 26; version 3.2.5
69 Fix source address bug in SI95 receive/send funcitons.
70 Fix threading issues involving session disconnection in SI95
71 Remove unused SI95 status variable.
72
E. Scott Danielsbf897292020-02-24 10:14:56 -0500732020 February 24; version 3.2.4
74 Fix meid bug (RIC-220) causing core dump.
75
E. Scott Daniels99584a22020-02-21 13:58:19 -0500762020 February 21; version 3.2.3
77 Add meid routing support to the SI95 interface.
78
E. Scott Daniels6d112572020-02-20 14:43:35 -0500792020 February 20; version 3.2.2
80 Fix receive thread related core dump (ring early unlock).
81
E. Scott Danielsab6d04c2020-02-19 09:47:06 -0500822020 February 19; version 3.2.1
83 Added missing message types (E2-Setup)
84
E. Scott Daniels4919b112020-02-14 09:23:59 -0500852020 February 18; version 3.2.0
86 Added support for new Route Manager and it's ability to accept
87 a request for table update.
88
E. Scott Daniels2bc430a2020-02-14 09:31:48 -0500892020 February 14; version 3.1.3
90 Fix bug in SIsend which was causing a core dump in some cases
91 where the application attempted to send on a connection that
92 had disconnected. (RIC-207).
93
E. Scott Daniels1c610aa2020-02-06 13:46:34 -0500942020 February 6; version 3.1.2
95 Fix disconnection detection bug in interface to SI95.
96
E. Scott Daniels05ce11d2020-01-31 16:10:34 -0500972020 January 31; verison 3.1.1
98 Allow route table thread logging to be completely disabled
E. Scott Danielsd9615252020-04-01 14:01:02 -040099 when logging is turned off.
E. Scott Daniels05ce11d2020-01-31 16:10:34 -0500100
E. Scott Daniels0d4def62020-01-28 16:50:27 -05001012020 January 26; verison 3.1.0
102 First step to allowing the user programme to control messages
103 written to standard error. Introduces the rmr_set_vlevel()
104 function, and related environment variable.
105
E. Scott Danielsa1575da2020-01-24 16:00:11 -05001062020 January 24; verison 3.0.5
107 Fix bug in SI95 with receive buffer allocation.
108
E. Scott Danielsbc3de172020-01-23 16:20:12 -05001092020 January 23; verison 3.0.4
110 Fix bug in SI95 causing excessive CPU usage on poll.
111
E. Scott Danielsc1f84f82020-01-22 12:31:07 -05001122020 January 22; verison 3.0.3
113 Enable thread support for multiple receive threads.
114
E. Scott Daniels02e8d492020-01-21 12:23:28 -05001152020 January 21; verison 3.0.2
116 Fix bug in SI95 (missing reallocate payload function).
117
E. Scott Daniels5200efe2020-01-20 10:31:44 -05001182020 January 20; verison 3.0.1
119 Enable support for dynamic route table updates via RMR session.
120
E. Scott Danielsec88d3c2019-11-13 09:40:22 -05001212020 January 16; version 3.0.0
122 Introduce support for SI95 transport library to replace NNG.
123 (RMR library versions will use leading odd numbers to avoid tag collisions
124 with the wrapper tags which will use even numbers.)
125
E. Scott Daniels190665f2019-12-09 09:05:22 -05001262019 December 9; version 1.13.1
127 Correct documentation and missing rel-notes update for RTD.
128
E. Scott Daniels0b79fc22019-12-04 15:20:16 -05001292019 December 6; version 1.13.0
130 Add ability to route messages based on the MEID in a message combined
131 with the message type/subscription-ID.
132
E. Scott Daniels0b79fc22019-12-04 15:20:16 -05001332019 November 14; version 1.11.1 (Amber)
E. Scott Danielsde63b292019-11-14 16:03:51 -0500134 Fix bug in payload reallocation function; correct length of payload
135 was not always copied.
136
E. Scott Daniels076ac472019-11-13 10:02:37 -05001372019 November 13; version 1.12.1
138 New message type constants added to support A1.
139
E. Scott Daniels0b79fc22019-12-04 15:20:16 -05001402019 November 4; version 1.11.0 (Amber)
E. Scott Danielsde63b292019-11-14 16:03:51 -0500141 Version bump to move away from the 1.10.* to distinguish between
142 release A and the trial.
143
E. Scott Daniels076ac472019-11-13 10:02:37 -05001442019 November 7; version 1.12.0
145 Version cut to support continued development for next release
E. Scott Danielsd9615252020-04-01 14:01:02 -0400146 preserving the 1.11.* versions for release 1 (Amber) and
E. Scott Daniels076ac472019-11-13 10:02:37 -0500147 related fixes.
148
E. Scott Danielsd9de79a2019-10-31 09:20:33 -04001492019 October 31; version 1.10.2
150 Provide the means to increase the payload size of a received message
151 without losing the data needed to use the rmr_rts_msg() funciton.
152
E. Scott Daniels7d1b7b02019-10-22 16:23:36 -04001532019 October 21; version 1.10.1
154 Fix to prevent null message buffer from being returned by the timeout
155 receive function if the function is passed one to reuse.
156
1572019 October 21; version 1.10.1
158 Add periodic dump of send count info to stderr.
159
E. Scott Danielsfa09c302019-09-27 12:45:31 -04001602019 September 27; version 1.9.0
161 Python bindings added receive all queued function and corrected a unit test
162
E. Scott Daniels5b8070a2019-09-25 13:02:30 -04001632019 September 25; version 1.8.3
164 Correct application level test issue causing timing problems during
165 jenkins verification testing at command and merge
166
E. Scott Danielsde63b292019-11-14 16:03:51 -0500167 Handle the NNG connection shutdown status which may now be
E. Scott Daniels5b8070a2019-09-25 13:02:30 -0400168 generated when a connection throug a proxy is reset.
169
E. Scott Danielse21dbee2019-09-25 11:06:07 -04001702019 September 25; version 1.8.2
171 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
172
E. Scott Daniels4441a792019-09-19 11:09:40 -04001732019 September 19; version 1.8.1
174 Correct missing constant for wrappers.
E. Scott Danielsde63b292019-11-14 16:03:51 -0500175
E. Scott Daniels13114d12019-09-19 08:40:39 -04001762019 September 19; version 1.8.0
177 New message types added:
178 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
179
1802019 September 17; version 1.7.0
181 Initial connection mode now defaults to asynchronous. Set RMR_ASYNC_CONN=0
182 in the environment before rmr_init() is invoked to revert to
183 synchronous first TCP connections. (Recovery connection attempts
184 have always been asynchronous).
185
E. Scott Danielsdfe7b622019-09-03 10:52:41 -04001862019 September 3; version 1.6.0
187 Fix bug in the rmr_rts_msg() function. If a return to sender message
188 failed, the source IP address was not correctly adjusted and could
189 cause the message to be "reflected" back to the sender on a retry.
190
191 Added the ability to set the source "ID" via an environment var
192 (RMR_SRC_ID). When present in the environment, the string will
193 be placed in to the message header as the source and thus be used
194 by an application calling rmr_rts_smg() to return a response to
195 the sender. If this environment variable is not present, the host
196 name (original behaviour) is used.
197
E. Scott Danielsde63b292019-11-14 16:03:51 -05001982019 August 26; version 1.4.0
E. Scott Daniels36262112019-08-26 10:50:52 -0400199 New message types were added.
200
2012019 August 16; version 1.3.0
202 New mesage types added.
203
E. Scott Daniels4ac73e32019-08-13 11:35:04 -04002042019 August 13; version 1.2.0 (API change, non-breaking)
205 The function rmr_get_xact() was added to proide a convenient
206 way to extract the transaction field from a message.
207
E. Scott Danielsf68c2ce2019-08-08 10:15:43 -04002082019 August 8; version 1.1.0 (API change)
209 This change should be backward compatable/non-breaking
210 A new field has been added to the message buffer (rmr_mbuf_t).
211 This field (tp_state) is used to communicate the errno value
212 that the transport mechanism might set during send and/or
213 receive operations. C programmes should continue to use
214 errno directly, but in some environments wrappers may not be
E. Scott Danielsde63b292019-11-14 16:03:51 -0500215 able to access errno and this provides the value to them.
E. Scott Danielsf68c2ce2019-08-08 10:15:43 -0400216 See the rmr_alloc_msg manual page for more details.
E. Scott Danielsde63b292019-11-14 16:03:51 -0500217
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -04002182019 August 6; version 1.0.45 (build changes)
219 Support for the Nanomsg transport library has been dropped.
220 The library librmr.* will no longer be included in packages.
221
222 Packages will install RMR libraries into the system preferred
223 target directory. On some systems this is /usr/local/lib
224 and on others it is /usr/local/lib64. The diretory is
225 determined by the sytem on which the package is built and
226 NOT by the system installing the package, so it's possible
227 that the RMR libraries end up in a strange location if the
228 .deb or .rpm file was generated on a Linux flavour that
229 has a different preference than the one where the package
230 is installed.
231
2322019 August 6; version 1.0.44 (API change)
E. Scott Danielsdebe5042019-08-06 08:36:50 -0400233 Added a new message type constant.
234
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -04002352019 July 15; Version 1.0.39 (bug fix)
E. Scott Daniels6efa7aa2019-07-15 10:31:42 -0400236 Prevent unnecessary usleep in retry loop.
237
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -04002382019 July 12; Version 1.0.38 (API change)
E. Scott Danielsec1fc362019-07-12 15:00:28 -0400239 Added new message types to RIC_message_types.h.
240
E. Scott Danielsa7610c62019-07-11 10:24:01 -04002412019 July 11; Version 1.0.37
242
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400243 librmr and librmr_nng
E. Scott Danielsa7610c62019-07-11 10:24:01 -0400244 - Add message buffer API function rmr_trace_ref()
245 (see rmr_trace_ref.3 manual page in dev package).
E. Scott Danielsec1fc362019-07-12 15:00:28 -0400246