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/>`__.
16 * It's been past due to bump this to 1.0.0 since people depend on it!
17 * Add the ability to set sbuf attributes in the same call that it is allocated
18 * (breaking) removes bytes2meid
19 * (breaking) rmr_set_meid now infers length
20 * (breaking) rmr_get_meid now returns bytes, to be symmetric with set_meid
28 * Add an exceptions module and raise a proper exception when an allocated buffer has a NULL pointer. Likely due to a bad rmr context.
35 * Correct cause of nil pointer exception in message summary.
43 * Add missing unit test for receive all.
44 * Correct bug in summary function.
51 * Fix a constant name (RMRFL_MT_CALL)
58 * 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.
64 * Add a helpers module to provide extensions and helper functions such as receive all queued messages.
65 * Enhance unit test to check only for RMR constants which are needed.
66 * Correct unprintable characters in documentation.
73 * 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
74 * 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.
75 * 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.
82 * 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.
83 * Adds an alias rmr_set_meid to rmr_bytes2meid for naming consistency.
84 * Found a possible inconsistency/bug that requires further investigation later; setting meid takes bytes, but getting it returns a string.
91 * Fix invocation of _rmr_alloc function
98 * Finish sphinx documentation
99 * Make public functions that wrap ctype declarions, allowing for docstrings
100 * Fix a bug where rmr_set_stimeout was pointing to the wrong function
107 * Moves Changelog.md to this file, to be consistent with rst-ification
108 * Sets up a Dockerfile to generate documentation for rmr-python using sphinx
116 * Make the PYPI page for rmr look nicer.
125 * Fix underlying problem getting errno from some environments; now references new RMR message field to get errno value.
126 * Add /usr/local/lib64 to tox environment variable to support systems where libraries natually install in lib64 rather than lib.
135 * (Correctly) Include license here per Jira RICPLT-1855
144 * Include license here per Jira RICPLT-1855
153 * Fix a bug in rmr mock that prevented it for being used for rmr_rcv (was only usable for rmr_torcv)
154 * Add more unit tests, esp for message summary
155 * Remove meid truncation in the case where a nil is present mid string
156 * Change the defaul mock of meid and get_src to something more useful
165 * Add a new module for mocking out rmr-python, useful for other packages that depend on rmr-python
174 * Add some unit tests; more to come
183 * Better loop indexing in meid string handling
193 * add liscneses for LF push
202 * Better andling of meid in message summary
211 * Refactor some code to be more functional
212 * Put back RMR_MAX_RCV_BYTES as a constant
213 * Add tox.ini, although right now it only LINTs
222 * Add constant fetching from RMr library
231 * Add a new field to rmr_mbuf_t: sub_id
232 * Fix prior commits lint-ailing python style
241 * Add errno access via new function: rmr.errno()
242 * Add new functions to access new RMr header fields: get_src, get_meid, rmr_bytes2meid
243 * Add new RMr constants for error states
252 * Fix a non-ascii encoding issue
261 * Greatly imroved test sender/receiver
262 * Three new functions implemented (rmr_close, rmr_set_stimeout, rmr_payload_size)
271 * Support a new receive function that (hurray!) has a timeout
280 * Add two new MR states
289 * Switch to NNG from nanomessage