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