blob: a11875205cdab909bda517ede43435973580ae7a [file] [log] [blame]
E. Scott Daniels52f4bc92020-03-13 11:10:34 -04001# this file should contain ONLY the changes related to the
2# 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 Daniels338fe5e2020-03-30 11:05:45 -040082020 March 30; version 3.6.3
9 Correct the max receive message size constant in rmr.h (RIC-301)
10
E. Scott Daniels116d0f52020-03-23 14:37:16 -0400112020 March 23; version 3.6.2
12 Fix message initialisation bug when pulling a message from
13 the pool (RIC-295)
14
E. Scott Daniels0949fab2020-03-18 23:50:57 -0400152020 March 19; version 3.6.1
16 Fix problem with RPM package install
17
E. Scott Danielsfe9b5bd2020-03-18 08:41:07 -0400182020 March 18; version 3.6.0
19 Add message types to support traffic steering
20
E. Scott Daniels33a2b862020-03-16 13:12:59 -0400212020 March 16; version 3.5.2
22 Correct bug in the meid table parser that prevented the
23 ack/nack of meid tables (RIC-273)
24
E. Scott Daniels7edb9ff2020-03-10 08:28:37 -0400252020 March 10; version 3.5.1
26 Add missing health check message types.
27
E. Scott Daniels8633a0b2020-03-09 13:57:39 -0400282020 March 9; version 3.5.0
29 Added new wormhole send function: rmr_wh_call().
30
E. Scott Daniels4d1f9bf2020-03-06 12:29:28 -0500312020 March 6; version 3.4.0
32 Add new wormhole state function: rmr_wh_state().
33
E. Scott Daniels6926c662020-03-06 09:13:06 -0500342020 March 5; Version 3.3.1
35 Correct several "bugs" identified by automatic code analysis.
36
372020 March 4; Version 3.3.0
38 Add SI95 based unit testing
39 Health check support binary added (reason for minor bump)
40
E. Scott Daniels20829ec2020-02-26 14:28:54 -0500412020 February 26; version 3.2.5
42 Fix source address bug in SI95 receive/send funcitons.
43 Fix threading issues involving session disconnection in SI95
44 Remove unused SI95 status variable.
45
E. Scott Danielsbf897292020-02-24 10:14:56 -0500462020 February 24; version 3.2.4
47 Fix meid bug (RIC-220) causing core dump.
48
E. Scott Daniels99584a22020-02-21 13:58:19 -0500492020 February 21; version 3.2.3
50 Add meid routing support to the SI95 interface.
51
E. Scott Daniels6d112572020-02-20 14:43:35 -0500522020 February 20; version 3.2.2
53 Fix receive thread related core dump (ring early unlock).
54
E. Scott Danielsab6d04c2020-02-19 09:47:06 -0500552020 February 19; version 3.2.1
56 Added missing message types (E2-Setup)
57
E. Scott Daniels4919b112020-02-14 09:23:59 -0500582020 February 18; version 3.2.0
59 Added support for new Route Manager and it's ability to accept
60 a request for table update.
61
E. Scott Daniels2bc430a2020-02-14 09:31:48 -0500622020 February 14; version 3.1.3
63 Fix bug in SIsend which was causing a core dump in some cases
64 where the application attempted to send on a connection that
65 had disconnected. (RIC-207).
66
E. Scott Daniels1c610aa2020-02-06 13:46:34 -0500672020 February 6; version 3.1.2
68 Fix disconnection detection bug in interface to SI95.
69
E. Scott Daniels05ce11d2020-01-31 16:10:34 -0500702020 January 31; verison 3.1.1
71 Allow route table thread logging to be completely disabled
72 when logging is turned off.
73
E. Scott Daniels0d4def62020-01-28 16:50:27 -0500742020 January 26; verison 3.1.0
75 First step to allowing the user programme to control messages
76 written to standard error. Introduces the rmr_set_vlevel()
77 function, and related environment variable.
78
E. Scott Danielsa1575da2020-01-24 16:00:11 -0500792020 January 24; verison 3.0.5
80 Fix bug in SI95 with receive buffer allocation.
81
E. Scott Danielsbc3de172020-01-23 16:20:12 -0500822020 January 23; verison 3.0.4
83 Fix bug in SI95 causing excessive CPU usage on poll.
84
E. Scott Danielsc1f84f82020-01-22 12:31:07 -0500852020 January 22; verison 3.0.3
86 Enable thread support for multiple receive threads.
87
E. Scott Daniels02e8d492020-01-21 12:23:28 -0500882020 January 21; verison 3.0.2
89 Fix bug in SI95 (missing reallocate payload function).
90
E. Scott Daniels5200efe2020-01-20 10:31:44 -0500912020 January 20; verison 3.0.1
92 Enable support for dynamic route table updates via RMR session.
93
E. Scott Danielsec88d3c2019-11-13 09:40:22 -0500942020 January 16; version 3.0.0
95 Introduce support for SI95 transport library to replace NNG.
96 (RMR library versions will use leading odd numbers to avoid tag collisions
97 with the wrapper tags which will use even numbers.)
98
E. Scott Daniels190665f2019-12-09 09:05:22 -0500992019 December 9; version 1.13.1
100 Correct documentation and missing rel-notes update for RTD.
101
E. Scott Daniels0b79fc22019-12-04 15:20:16 -05001022019 December 6; version 1.13.0
103 Add ability to route messages based on the MEID in a message combined
104 with the message type/subscription-ID.
105
E. Scott Daniels0b79fc22019-12-04 15:20:16 -05001062019 November 14; version 1.11.1 (Amber)
E. Scott Danielsde63b292019-11-14 16:03:51 -0500107 Fix bug in payload reallocation function; correct length of payload
108 was not always copied.
109
E. Scott Daniels076ac472019-11-13 10:02:37 -05001102019 November 13; version 1.12.1
111 New message type constants added to support A1.
112
E. Scott Daniels0b79fc22019-12-04 15:20:16 -05001132019 November 4; version 1.11.0 (Amber)
E. Scott Danielsde63b292019-11-14 16:03:51 -0500114 Version bump to move away from the 1.10.* to distinguish between
115 release A and the trial.
116
E. Scott Daniels076ac472019-11-13 10:02:37 -05001172019 November 7; version 1.12.0
118 Version cut to support continued development for next release
119 preserving the 1.11.* versions for release 1 (Amber) and
120 related fixes.
121
E. Scott Danielsd9de79a2019-10-31 09:20:33 -04001222019 October 31; version 1.10.2
123 Provide the means to increase the payload size of a received message
124 without losing the data needed to use the rmr_rts_msg() funciton.
125
E. Scott Daniels7d1b7b02019-10-22 16:23:36 -04001262019 October 21; version 1.10.1
127 Fix to prevent null message buffer from being returned by the timeout
128 receive function if the function is passed one to reuse.
129
1302019 October 21; version 1.10.1
131 Add periodic dump of send count info to stderr.
132
E. Scott Danielsfa09c302019-09-27 12:45:31 -04001332019 September 27; version 1.9.0
134 Python bindings added receive all queued function and corrected a unit test
135
E. Scott Daniels5b8070a2019-09-25 13:02:30 -04001362019 September 25; version 1.8.3
137 Correct application level test issue causing timing problems during
138 jenkins verification testing at command and merge
139
E. Scott Danielsde63b292019-11-14 16:03:51 -0500140 Handle the NNG connection shutdown status which may now be
E. Scott Daniels5b8070a2019-09-25 13:02:30 -0400141 generated when a connection throug a proxy is reset.
142
E. Scott Danielse21dbee2019-09-25 11:06:07 -04001432019 September 25; version 1.8.2
144 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
145
E. Scott Daniels4441a792019-09-19 11:09:40 -04001462019 September 19; version 1.8.1
147 Correct missing constant for wrappers.
E. Scott Danielsde63b292019-11-14 16:03:51 -0500148
E. Scott Daniels13114d12019-09-19 08:40:39 -04001492019 September 19; version 1.8.0
150 New message types added:
151 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
152
1532019 September 17; version 1.7.0
154 Initial connection mode now defaults to asynchronous. Set RMR_ASYNC_CONN=0
155 in the environment before rmr_init() is invoked to revert to
156 synchronous first TCP connections. (Recovery connection attempts
157 have always been asynchronous).
158
E. Scott Danielsdfe7b622019-09-03 10:52:41 -04001592019 September 3; version 1.6.0
160 Fix bug in the rmr_rts_msg() function. If a return to sender message
161 failed, the source IP address was not correctly adjusted and could
162 cause the message to be "reflected" back to the sender on a retry.
163
164 Added the ability to set the source "ID" via an environment var
165 (RMR_SRC_ID). When present in the environment, the string will
166 be placed in to the message header as the source and thus be used
167 by an application calling rmr_rts_smg() to return a response to
168 the sender. If this environment variable is not present, the host
169 name (original behaviour) is used.
170
E. Scott Danielsde63b292019-11-14 16:03:51 -05001712019 August 26; version 1.4.0
E. Scott Daniels36262112019-08-26 10:50:52 -0400172 New message types were added.
173
1742019 August 16; version 1.3.0
175 New mesage types added.
176
E. Scott Daniels4ac73e32019-08-13 11:35:04 -04001772019 August 13; version 1.2.0 (API change, non-breaking)
178 The function rmr_get_xact() was added to proide a convenient
179 way to extract the transaction field from a message.
180
E. Scott Danielsf68c2ce2019-08-08 10:15:43 -04001812019 August 8; version 1.1.0 (API change)
182 This change should be backward compatable/non-breaking
183 A new field has been added to the message buffer (rmr_mbuf_t).
184 This field (tp_state) is used to communicate the errno value
185 that the transport mechanism might set during send and/or
186 receive operations. C programmes should continue to use
187 errno directly, but in some environments wrappers may not be
E. Scott Danielsde63b292019-11-14 16:03:51 -0500188 able to access errno and this provides the value to them.
E. Scott Danielsf68c2ce2019-08-08 10:15:43 -0400189 See the rmr_alloc_msg manual page for more details.
E. Scott Danielsde63b292019-11-14 16:03:51 -0500190
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -04001912019 August 6; version 1.0.45 (build changes)
192 Support for the Nanomsg transport library has been dropped.
193 The library librmr.* will no longer be included in packages.
194
195 Packages will install RMR libraries into the system preferred
196 target directory. On some systems this is /usr/local/lib
197 and on others it is /usr/local/lib64. The diretory is
198 determined by the sytem on which the package is built and
199 NOT by the system installing the package, so it's possible
200 that the RMR libraries end up in a strange location if the
201 .deb or .rpm file was generated on a Linux flavour that
202 has a different preference than the one where the package
203 is installed.
204
2052019 August 6; version 1.0.44 (API change)
E. Scott Danielsdebe5042019-08-06 08:36:50 -0400206 Added a new message type constant.
207
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -04002082019 July 15; Version 1.0.39 (bug fix)
E. Scott Daniels6efa7aa2019-07-15 10:31:42 -0400209 Prevent unnecessary usleep in retry loop.
210
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -04002112019 July 12; Version 1.0.38 (API change)
E. Scott Danielsec1fc362019-07-12 15:00:28 -0400212 Added new message types to RIC_message_types.h.
213
E. Scott Danielsa7610c62019-07-11 10:24:01 -04002142019 July 11; Version 1.0.37
215
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400216 librmr and librmr_nng
E. Scott Danielsa7610c62019-07-11 10:24:01 -0400217 - Add message buffer API function rmr_trace_ref()
218 (see rmr_trace_ref.3 manual page in dev package).
E. Scott Danielsec1fc362019-07-12 15:00:28 -0400219