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