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