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