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