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