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 November 14; version 1.11.1
  19 --------------------------------------------------------------------------------------------
  20
  21 Fix bug in payload reallocation function; correct length of
  22 payload was not always copied.
  23
  24
  25 2019 November 4; version 1.11.0
  26 --------------------------------------------------------------------------------------------
  27
  28 Version bump to move away from the 1.10.* to distinguish
  29 between release A and the trial.
  30
  31
  32 2019 October 31; version 1.10.2
  33 --------------------------------------------------------------------------------------------
  34
  35 Provide the means to increase the payload size of a received
  36 message without losing the data needed to use the
  37 rmr_rts_msg() funciton.
  38
  39
  40 2019 October 21; version 1.10.1
  41 --------------------------------------------------------------------------------------------
  42
  43 Fix to prevent null message buffer from being returned by the
  44 timeout receive function if the function is passed one to
  45 reuse.
  46
  47
  48 2019 October 21; version 1.10.1
  49 --------------------------------------------------------------------------------------------
  50
  51 Add periodic dump of send count info to stderr.
  52
  53
  54 2019 September 27; version 1.9.0
  55 --------------------------------------------------------------------------------------------
  56
  57 Python bindings added receive all queued function and
  58 corrected a unit test
  59
  60
  61 2019 September 25; version 1.8.3
  62 --------------------------------------------------------------------------------------------
  63
  64 Correct application level test issue causing timing problems
  65 during jenkins verification testing at command and merge
  66
  67 Handle the NNG connection shutdown status which may now be
  68 generated when a connection throug a proxy is reset.
  69
  70
  71 2019 September 25; version 1.8.2
  72 --------------------------------------------------------------------------------------------
  73
  74 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
  75
  76
  77 2019 September 19; version 1.8.1
  78 --------------------------------------------------------------------------------------------
  79
  80 Correct missing constant for wrappers.
  81
  82
  83 2019 September 19; version 1.8.0
  84 --------------------------------------------------------------------------------------------
  85
  86 New message types added: RAN_CONNECTED, RAN_RESTARTED,
  87 RAN_RECONFIGURED
  88
  89
  90 2019 September 17; version 1.7.0
  91 --------------------------------------------------------------------------------------------
  92
  93 Initial connection mode now defaults to asynchronous. Set
  94 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
  95 invoked to revert to synchronous first TCP connections.
  96 (Recovery connection attempts have always been asynchronous).
  97
  98
  99 2019 September 3; version 1.6.0
 100 --------------------------------------------------------------------------------------------
 101
 102 Fix bug in the rmr_rts_msg() function. If a return to sender
 103 message failed, the source IP address was not correctly
 104 adjusted and could cause the message to be "reflected" back
 105 to the sender on a retry.
 106
 107 Added the ability to set the source "ID" via an environment
 108 var (RMR_SRC_ID). When present in the environment, the string
 109 will be placed in to the message header as the source and
 110 thus be used by an application calling rmr_rts_smg() to
 111 return a response to the sender. If this environment variable
 112 is not present, the host name (original behaviour) is used.
 113
 114
 115 2019 August 26; version 1.4.0
 116 --------------------------------------------------------------------------------------------
 117
 118 New message types were added.
 119
 120
 121 2019 August 16; version 1.3.0
 122 --------------------------------------------------------------------------------------------
 123
 124 New mesage types added.
 125
 126
 127 2019 August 13; version 1.2.0 (API change, non-breaking)
 128 --------------------------------------------------------------------------------------------
 129
 130 The function rmr_get_xact() was added to proide a convenient
 131 way to extract the transaction field from a message.
 132
 133
 134 2019 August 8; version 1.1.0 (API change)
 135 --------------------------------------------------------------------------------------------
 136
 137 This change should be backward compatable/non-breaking A new
 138 field has been added to the message buffer (rmr_mbuf_t). This
 139 field (tp_state) is used to communicate the errno value that
 140 the transport mechanism might set during send and/or receive
 141 operations. C programmes should continue to use errno
 142 directly, but in some environments wrappers may not be able
 143 to access errno and this provides the value to them. See the
 144 rmr_alloc_msg manual page for more details.
 145
 146
 147 2019 August 6; version 1.0.45 (build changes)
 148 --------------------------------------------------------------------------------------------
 149
 150 Support for the Nanomsg transport library has been dropped.
 151 The library librmr.* will no longer be included in packages.
 152
 153 Packages will install RMR libraries into the system preferred
 154 target directory. On some systems this is /usr/local/lib and
 155 on others it is /usr/local/lib64. The diretory is determined
 156 by the sytem on which the package is built and NOT by the
 157 system installing the package, so it's possible that the RMR
 158 libraries end up in a strange location if the .deb or .rpm
 159 file was generated on a Linux flavour that has a different
 160 preference than the one where the package is installed.
 161
 162
 163 2019 August 6; version 1.0.44 (API change)
 164 --------------------------------------------------------------------------------------------
 165
 166 Added a new message type constant.
 167
 168
 169 2019 July 15; Version 1.0.39 (bug fix)
 170 --------------------------------------------------------------------------------------------
 171
 172 Prevent unnecessary usleep in retry loop.
 173
 174
 175 2019 July 12; Version 1.0.38 (API change)
 176 --------------------------------------------------------------------------------------------
 177
 178 Added new message types to RIC_message_types.h.
 179
 180
 181 2019 July 11; Version 1.0.37
 182 --------------------------------------------------------------------------------------------
 183
 184
 185 librmr and librmr_nng - Add message buffer API function
 186 rmr_trace_ref() (see rmr_trace_ref.3 manual page in dev
 187 package).
 188