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