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