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