4 All notable changes to this project will be documented in this file.
6 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
7 and this project adheres to `Semantic
8 Versioning <http://semver.org/>`__.
15 * Switch to SI95 instead of NNG. This is a breaking change. SI95 rmr users cannot talk to NNG rmr users.
16 * The version bump from 2 to 4 is due to the "roommate" issue in the rmr repo.
24 * Correct the MEID unit test (broken by RMR commit 190665fe)
25 * Change rmr_init to catch init failure reported by RMR
33 * add ability to set a deterministic transaction id in alloc, and in the mock of alloc
34 * add ability to set meid in fake alloc; before None was always returned erroneously
35 * Fix a bug where fake_alloc was way out of date with alloc, and add a test for it
43 * Allow the setting of payload and message type in rts
44 * Add a new function, helpers.rmr_rcvall_msgs_raw, that also returns the sbuf alongside the summary
45 * Add a mock for free_msg
52 * This is a breaking change as it rquires that RMR version 1.10.2 or later be used.
53 * The populate and set length function will reallocate the message buffer payload if the caller attempts to insert more bytes than the currrent message supports.
54 * add ability to set subscription id when allocating a message
55 * add testing involving subscription ids
63 * It's been past due to bump this to 1.0.0 since people depend on it!
64 * Add the ability to set sbuf attributes in the same call that it is allocated
65 * (breaking) removes bytes2meid
66 * (breaking) rmr_set_meid now infers length
67 * (breaking) rmr_get_meid now returns bytes, to be symmetric with set_meid
75 * Add an exceptions module and raise a proper exception when an allocated buffer has a NULL pointer. Likely due to a bad rmr context.
82 * Correct cause of nil pointer exception in message summary.
90 * Add missing unit test for receive all.
91 * Correct bug in summary function.
98 * Fix a constant name (RMRFL_MT_CALL)
105 * Correct unit test bug in rmr-python. With RMR 1.8.x connections are forced to be asynch by default to prevent kubernetes blocking the attempt for minutes. However, the asynch nature of connections makes unit tests concerned with the ability to send and receive messages non-deterministic as some connections are established before the first message is sent, and others are not. This change ensures that unit tests establish connections in a synchronous manner which ensures that the first send will not be rejected by NNG due to a pending connection.
111 * Add a helpers module to provide extensions and helper functions such as receive all queued messages.
112 * Enhance unit test to check only for RMR constants which are needed.
113 * Correct unprintable characters in documentation.
120 * Add final unit tests for rmr.py; unit test coverage for rmr python is about 95%. The remaining functions are dangerous to unit test directly, e.g., rcv which may block forever
121 * Fix a bug where meid was being intepreted as bytes (but then cast into a string); the correct interpretation is a string, so now it will truncate after a null byte.
122 * Removes access to the raw function rmr_get_meid(ptr, dest) in favor of just rmr_get_meid(ptr). Also get_meid is now rmr_get_meid since it wasn't consistent with the naming.
129 * Overhaul unit tests to remove mocking from the rmr tests, which gives much greater confidence in changing the code. More is still needed however, specifically test sends and test receives.
130 * Adds an alias rmr_set_meid to rmr_bytes2meid for naming consistency.
131 * Found a possible inconsistency/bug that requires further investigation later; setting meid takes bytes, but getting it returns a string.
138 * Fix invocation of _rmr_alloc function
145 * Finish sphinx documentation
146 * Make public functions that wrap ctype declarions, allowing for docstrings
147 * Fix a bug where rmr_set_stimeout was pointing to the wrong function
154 * Moves Changelog.md to this file, to be consistent with rst-ification
155 * Sets up a Dockerfile to generate documentation for rmr-python using sphinx
163 * Make the PYPI page for rmr look nicer.
172 * Fix underlying problem getting errno from some environments; now references new RMR message field to get errno value.
173 * Add /usr/local/lib64 to tox environment variable to support systems where libraries natually install in lib64 rather than lib.
182 * (Correctly) Include license here per Jira RICPLT-1855
191 * Include license here per Jira RICPLT-1855
200 * Fix a bug in rmr mock that prevented it for being used for rmr_rcv (was only usable for rmr_torcv)
201 * Add more unit tests, esp for message summary
202 * Remove meid truncation in the case where a nil is present mid string
203 * Change the defaul mock of meid and get_src to something more useful
212 * Add a new module for mocking out rmr-python, useful for other packages that depend on rmr-python
221 * Add some unit tests; more to come
230 * Better loop indexing in meid string handling
240 * add liscneses for LF push
249 * Better andling of meid in message summary
258 * Refactor some code to be more functional
259 * Put back RMR_MAX_RCV_BYTES as a constant
260 * Add tox.ini, although right now it only LINTs
269 * Add constant fetching from RMr library
278 * Add a new field to rmr_mbuf_t: sub_id
279 * Fix prior commits lint-ailing python style
288 * Add errno access via new function: rmr.errno()
289 * Add new functions to access new RMr header fields: get_src, get_meid, rmr_bytes2meid
290 * Add new RMr constants for error states
299 * Fix a non-ascii encoding issue
308 * Greatly imroved test sender/receiver
309 * Three new functions implemented (rmr_close, rmr_set_stimeout, rmr_payload_size)
318 * Support a new receive function that (hurray!) has a timeout
327 * Add two new MR states
336 * Switch to NNG from nanomessage
Code Review / ric-plt / lib / rmr.git / blob