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