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