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