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