docs/rel-notes.rst

   1
   2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   3 .. SPDX-License-Identifier: CC-BY-4.0
   4 .. CAUTION: this document is generated from source in doc/src/rtd.
   5 .. To make changes edit the source and recompile the document.
   6 .. Do NOT make changes directly to .rst or .md files.
   7
   8
   9 RMR Release Notes
  10 ============================================================================================
  11
  12 The following is a list of release highlights for the core
  13 RMR library. These are extracted directly from the CHANGES
  14 file at the repo root; please refer to that file for a
  15 completely up to date listing of API changes.
  16
  17
  18 2019 December 9; version 1.13.1
  19 --------------------------------------------------------------------------------------------
  20
  21 Correct documentation and missing rel-notes update for RTD.
  22
  23
  24 2019 December 6; version 1.13.0
  25 --------------------------------------------------------------------------------------------
  26
  27 Add ability to route messages based on the MEID in a message
  28 combined with the message type/subscription-ID.
  29
  30
  31
  32 2019 November 14; version 1.11.1 (Amber)
  33 --------------------------------------------------------------------------------------------
  34
  35 Fix bug in payload reallocation function; correct length of
  36 payload was not always copied.
  37
  38
  39 2019 November 13; version 1.12.1
  40 --------------------------------------------------------------------------------------------
  41
  42 New message type constants added to support A1.
  43
  44
  45 2019 November 4; version 1.11.0 (Amber)
  46 --------------------------------------------------------------------------------------------
  47
  48 Version bump to move away from the 1.10.* to distinguish
  49 between release A and the trial.
  50
  51
  52 2019 November 7; version 1.12.0
  53 --------------------------------------------------------------------------------------------
  54
  55 Version cut to support continued development for next release
  56 preserving the 1.11.* versions for release 1 (Amber) and
  57 related fixes.
  58
  59
  60 2019 October 31; version 1.10.2
  61 --------------------------------------------------------------------------------------------
  62
  63 Provide the means to increase the payload size of a received
  64 message without losing the data needed to use the
  65 rmr_rts_msg() funciton.
  66
  67
  68 2019 October 21; version 1.10.1
  69 --------------------------------------------------------------------------------------------
  70
  71 Fix to prevent null message buffer from being returned by the
  72 timeout receive function if the function is passed one to
  73 reuse.
  74
  75
  76 2019 October 21; version 1.10.1
  77 --------------------------------------------------------------------------------------------
  78
  79 Add periodic dump of send count info to stderr.
  80
  81
  82 2019 September 27; version 1.9.0
  83 --------------------------------------------------------------------------------------------
  84
  85 Python bindings added receive all queued function and
  86 corrected a unit test
  87
  88
  89 2019 September 25; version 1.8.3
  90 --------------------------------------------------------------------------------------------
  91
  92 Correct application level test issue causing timing problems
  93 during jenkins verification testing at command and merge
  94
  95 Handle the NNG connection shutdown status which may now be
  96 generated when a connection throug a proxy is reset.
  97
  98
  99 2019 September 25; version 1.8.2
 100 --------------------------------------------------------------------------------------------
 101
 102 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
 103
 104
 105 2019 September 19; version 1.8.1
 106 --------------------------------------------------------------------------------------------
 107
 108 Correct missing constant for wrappers.
 109
 110
 111 2019 September 19; version 1.8.0
 112 --------------------------------------------------------------------------------------------
 113
 114 New message types added: RAN_CONNECTED, RAN_RESTARTED,
 115 RAN_RECONFIGURED
 116
 117
 118 2019 September 17; version 1.7.0
 119 --------------------------------------------------------------------------------------------
 120
 121 Initial connection mode now defaults to asynchronous. Set
 122 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
 123 invoked to revert to synchronous first TCP connections.
 124 (Recovery connection attempts have always been asynchronous).
 125
 126
 127 2019 September 3; version 1.6.0
 128 --------------------------------------------------------------------------------------------
 129
 130 Fix bug in the rmr_rts_msg() function. If a return to sender
 131 message failed, the source IP address was not correctly
 132 adjusted and could cause the message to be "reflected" back
 133 to the sender on a retry.
 134
 135 Added the ability to set the source "ID" via an environment
 136 var (RMR_SRC_ID). When present in the environment, the string
 137 will be placed in to the message header as the source and
 138 thus be used by an application calling rmr_rts_smg() to
 139 return a response to the sender. If this environment variable
 140 is not present, the host name (original behaviour) is used.
 141
 142
 143 2019 August 26; version 1.4.0
 144 --------------------------------------------------------------------------------------------
 145
 146 New message types were added.
 147
 148
 149 2019 August 16; version 1.3.0
 150 --------------------------------------------------------------------------------------------
 151
 152 New mesage types added.
 153
 154
 155 2019 August 13; version 1.2.0 (API change, non-breaking)
 156 --------------------------------------------------------------------------------------------
 157
 158 The function rmr_get_xact() was added to proide a convenient
 159 way to extract the transaction field from a message.
 160
 161
 162 2019 August 8; version 1.1.0 (API change)
 163 --------------------------------------------------------------------------------------------
 164
 165 This change should be backward compatable/non-breaking A new
 166 field has been added to the message buffer (rmr_mbuf_t). This
 167 field (tp_state) is used to communicate the errno value that
 168 the transport mechanism might set during send and/or receive
 169 operations. C programmes should continue to use errno
 170 directly, but in some environments wrappers may not be able
 171 to access errno and this provides the value to them. See the
 172 rmr_alloc_msg manual page for more details.
 173
 174
 175 2019 August 6; version 1.0.45 (build changes)
 176 --------------------------------------------------------------------------------------------
 177
 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 and
 183 on others it is /usr/local/lib64. The diretory is determined
 184 by the sytem on which the package is built and NOT by the
 185 system installing the package, so it's possible that the RMR
 186 libraries end up in a strange location if the .deb or .rpm
 187 file was generated on a Linux flavour that has a different
 188 preference than the one where the package is installed.
 189
 190
 191 2019 August 6; version 1.0.44 (API change)
 192 --------------------------------------------------------------------------------------------
 193
 194 Added a new message type constant.
 195
 196
 197 2019 July 15; Version 1.0.39 (bug fix)
 198 --------------------------------------------------------------------------------------------
 199
 200 Prevent unnecessary usleep in retry loop.
 201
 202
 203 2019 July 12; Version 1.0.38 (API change)
 204 --------------------------------------------------------------------------------------------
 205
 206 Added new message types to RIC_message_types.h.
 207
 208
 209 2019 July 11; Version 1.0.37
 210 --------------------------------------------------------------------------------------------
 211
 212
 213 librmr and librmr_nng - Add message buffer API function
 214 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
 215 package).
 216