f77ae13d410cca943f098b0bbfc5cc0656252a7b
[ric-plt/lib/rmr.git] / CHANGES
1
2 API and build change  and fix summaries. Doc correctsions
3 and/or changes are not mentioned here; see the commit messages.
4
5 2020 February 21; version 3.2.3
6         Add meid routing support to the SI95 interface.
7
8 2020 February 20; version 3.2.2
9         Fix receive thread related core dump (ring early unlock).
10
11 2020 February 19; version 3.2.1
12         Added missing message types (E2-Setup)
13
14 2020 February 18; version 3.2.0
15         Added support for new Route Manager and it's ability to accept
16         a request for table update.
17
18 2020 February 14; version 3.1.3
19         Fix bug in SIsend which was causing a core dump in some cases
20         where the application attempted to send on a connection that
21         had disconnected. (RIC-207).
22
23 2020 February 6; version 3.1.2
24         Fix disconnection detection bug in interface to SI95.
25
26 2020 January 31; verison 3.1.1
27         Allow route table thread logging to be completely disabled
28         when logging is turned off.     
29
30 2020 January 26; verison 3.1.0
31         First step to allowing the user programme to control messages
32         written to standard error. Introduces the rmr_set_vlevel()
33         function, and related environment variable.
34
35 2020 January 24; verison 3.0.5
36         Fix bug in SI95 with receive buffer allocation.
37
38 2020 January 23; verison 3.0.4
39         Fix bug in SI95 causing excessive CPU usage on poll.
40
41 2020 January 22; verison 3.0.3
42         Enable thread support for multiple receive threads.
43
44 2020 January 21; verison 3.0.2
45         Fix bug in SI95 (missing reallocate payload function).
46
47 2020 January 20; verison 3.0.1
48         Enable support for dynamic route table updates via RMR session.
49
50 2020 January 16; version 3.0.0
51         Introduce support for SI95 transport library to replace NNG.
52         (RMR library versions will use leading odd numbers to avoid tag collisions
53          with the wrapper tags which will use even numbers.)
54
55 2019 December 9; version 1.13.1
56         Correct documentation and missing rel-notes update for RTD.
57
58 2019 December 6; version 1.13.0
59         Add ability to route messages based on the MEID in a message combined
60         with the message type/subscription-ID.
61
62
63 2019 November 14; version 1.11.1 (Amber)
64         Fix bug in payload reallocation function; correct length of payload
65         was not always copied.
66
67 2019 November 13; version 1.12.1
68         New message type constants added to support A1.
69
70 2019 November 4; version 1.11.0 (Amber)
71         Version bump to move away from the 1.10.* to distinguish between
72         release A and the trial.
73
74 2019 November 7; version 1.12.0
75         Version cut to support continued development for next release
76         preserving the 1.11.* versions for release 1 (Amber) and 
77         related fixes.
78
79 2019 October 31; version 1.10.2
80         Provide the means to increase the payload size of a received message
81         without losing the data needed to use the rmr_rts_msg() funciton.
82
83 2019 October 21; version 1.10.1
84         Fix to prevent null message buffer from being returned by the timeout
85         receive function if the function is passed one to reuse.
86
87 2019 October 21; version 1.10.1
88         Add periodic dump of send count info to stderr.
89
90 2019 September 27; version 1.9.0
91         Python bindings added receive all queued function and corrected a unit test
92
93 2019 September 25; version 1.8.3
94         Correct application level test issue causing timing problems during
95         jenkins verification testing at command and merge
96
97         Handle the NNG connection shutdown status which may now be
98         generated when a connection throug a proxy is reset.
99
100 2019 September 25; version 1.8.2
101         Correct bug in rmr_torcv_msg() when timeout set to zero (0).
102
103 2019 September 19; version 1.8.1
104         Correct missing constant for wrappers.
105
106 2019 September 19; version 1.8.0
107         New message types added:
108                 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
109
110 2019 September 17; version 1.7.0
111         Initial connection mode now defaults to asynchronous. Set RMR_ASYNC_CONN=0
112         in the environment before rmr_init() is invoked to revert to
113         synchronous first TCP connections. (Recovery connection attempts
114         have always been asynchronous).
115
116 2019 September 3; version 1.6.0
117         Fix bug in the rmr_rts_msg() function. If a return to sender message
118         failed, the source IP address was not correctly adjusted and could
119         cause the message to be "reflected" back to the sender on a retry.
120
121         Added the ability to set the source "ID" via an environment var
122         (RMR_SRC_ID).  When present in the environment, the string will
123         be placed in to the message header as the source and thus be used
124         by an application calling rmr_rts_smg() to return a response to
125         the sender.  If this environment variable is not present, the host
126         name (original behaviour) is used.
127
128 2019 August 26; version 1.4.0
129         New message types were added.
130
131 2019 August 16; version 1.3.0
132         New mesage types added.
133
134 2019 August 13; version 1.2.0 (API change, non-breaking)
135         The function rmr_get_xact() was added to proide a convenient
136         way to extract the transaction field from a message.
137
138 2019 August 8; version 1.1.0 (API change)
139         This change should be backward compatable/non-breaking
140         A new field has been added to the message buffer (rmr_mbuf_t).
141         This field (tp_state) is used to communicate the errno value
142         that the transport mechanism might set during send and/or
143         receive operations.  C programmes should continue to use
144         errno directly, but in some environments wrappers may not be
145         able to access errno and this provides the value to them.
146         See the rmr_alloc_msg manual page for more details.
147
148 2019 August 6; version 1.0.45 (build changes)
149         Support for the Nanomsg transport library has been dropped.
150                 The library librmr.* will no longer be included in packages.
151
152         Packages will install RMR libraries into the system preferred
153                 target directory. On some systems this is /usr/local/lib
154                 and on others it is /usr/local/lib64.  The diretory is
155                 determined by the sytem on which the package is built and
156                 NOT by the system installing the package, so it's possible
157                 that the RMR libraries end up in a strange location if the
158                 .deb or .rpm file was generated on a Linux flavour that
159                 has a different preference than the one where the package
160                 is installed.
161
162 2019 August 6; version 1.0.44 (API change)
163         Added a new message type constant.
164
165 2019 July 15; Version 1.0.39 (bug fix)
166         Prevent unnecessary usleep in retry loop.
167
168 2019 July 12; Version 1.0.38 (API change)
169         Added new message types to RIC_message_types.h.
170
171 2019 July 11; Version 1.0.37
172
173         librmr and librmr_nng
174                 - Add message buffer API function rmr_trace_ref()
175                   (see rmr_trace_ref.3 manual page in dev package).
176