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