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