CHANGES

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