Prevent message truncation by populate function
[ric-plt/lib/rmr.git] / src / bindings / rmr-python / docs / Changelog.rst
index 87ed3ab..4fa1629 100644 (file)
@@ -7,6 +7,72 @@ The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
 and this project adheres to `Semantic
 Versioning <http://semver.org/>`__.
 
+[X.X.X] - 10/30/2019
+--------------------
+
+::
+    * This is a breaking change as it rquires that RMR version 1.10.2 or later be used.
+    * 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.
+
+
+[1.0.0] - 10/24/2019
+--------------------
+
+::
+
+    * It's been past due to bump this to 1.0.0 since people depend on it!
+    * Add the ability to set sbuf attributes in the same call that it is allocated
+    * (breaking) removes bytes2meid
+    * (breaking) rmr_set_meid now infers length
+    * (breaking) rmr_get_meid now returns bytes, to be symmetric with set_meid
+
+
+[0.13.5] - 10/23/2019
+--------------------
+
+::
+
+    * Add an exceptions module and raise a proper exception when an allocated buffer has a NULL pointer. Likely due to a bad rmr context.
+
+[0.13.4] - 10/21/2019
+--------------------
+
+::
+
+    * Correct cause of nil pointer exception in message summary.
+
+
+[0.13.3] - 10/10/2019
+--------------------
+
+::
+
+    * Add missing unit test for receive all.
+    * Correct bug in summary function.
+
+[0.13.2] - 10/2/2019
+--------------------
+
+::
+
+    * Fix a constant name (RMRFL_MT_CALL)
+
+[0.13.1] - 10/1/2019
+--------------------
+
+::
+
+    * 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.
+
+[0.13.0] - 9/27/2019
+--------------------
+
+::
+   * Add a helpers module to provide extensions and helper functions such as receive all queued messages.
+   * Enhance unit test to check only for RMR constants which are needed.
+   * Correct unprintable characters in documentation.
+
+
 [0.12.0] - 8/23/2019
 --------------------