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