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