Add new func, update rts

[ric-plt/lib/rmr.git] / src / bindings / rmr-python / rmr / helpers.py

diff --git a/src/bindings/rmr-python/rmr/helpers.py b/src/bindings/rmr-python/rmr/helpers.py
index 1f6ef28..ac4a46e 100644 (file)
--- a/src/bindings/rmr-python/rmr/helpers.py
+++ b/src/bindings/rmr-python/rmr/helpers.py
@@ -27,39 +27,76 @@ from rmr import rmr
 
 def rmr_rcvall_msgs(mrc, pass_filter=[]):
     """
-        Assemble an array of all messages which can be received without
-        blocking.  Effectively draining the message queue if RMR is started
-        in mt-call mode, or draining any waiting TCP buffers.  If the
-        pass_filter parameter is supplied it is treated as one or more message
-        types to accept (pass through). Using the default, an empty list, results
-        in messages with any type being captured.
-
-        Parameters
-        ----------
-            mrc: ctypes c_void_p
-                Pointer to the RMR context
-
-            pass_filter: list (optional)
-                The message type(s) to capture.
-
-        Returns
-        -------
-            list
-            List of message summaries, one for each message captured.
+    Assemble an array of all messages which can be received without
+    blocking.  Effectively draining the message queue if RMR is started
+    in mt-call mode, or draining any waiting TCP buffers.  If the
+    pass_filter parameter is supplied it is treated as one or more message
+    types to accept (pass through). Using the default, an empty list, results
+    in messages with any type being captured.
+
+    Parameters
+    ----------
+        mrc: ctypes c_void_p
+            Pointer to the RMR context
+
+        pass_filter: list (optional)
+            The message type(s) to capture.
+
+    Returns
+    -------
+        list of dict
+        List of message summaries, one for each message captured.
     """
 
     new_messages = []
-    mbuf = rmr.rmr_alloc_msg(mrc, 4096)         # allocate buffer to have something for a return status
+    mbuf = rmr.rmr_alloc_msg(mrc, 4096)  # allocate buffer to have something for a return status
 
     while True:
         mbuf = rmr.rmr_torcv_msg(mrc, mbuf, 0)  # set the timeout to 0 so this doesn't block!!
 
         summary = rmr.message_summary(mbuf)
-        if summary["message status"] != "RMR_OK":      # ok indicates msg received, stop on all other states
+        if summary["message status"] != "RMR_OK":  # ok indicates msg received, stop on all other states
             break
+
+        if len(pass_filter) == 0 or summary["message type"] in pass_filter:  # no filter, or passes; capture it
+            new_messages.append(summary)
+
+    rmr.rmr_free_msg(mbuf)  # must free message to avoid leak
+    return new_messages
+
+
+def rmr_rcvall_msgs_raw(mrc, pass_filter=[]):
+    """
+    Same as rmr_rcvall_msgs, but the raw sbuf is also returned.
+    Useful, for example, if rts is to be used.
+
+    Parameters
+    ----------
+        mrc: ctypes c_void_p
+            Pointer to the RMR context
+
+        pass_filter: list (optional)
+            The message type(s) to capture.
+
+    Returns
+    -------
+    list of tuple:$
+       List of tuples [(S, sbuf),...] where S is a message summary and sbuf is the raw message$
+       the caller is responsible for calling rmr.rmr_free_msg(sbuf) for each sbuf afterwards to prevent memory leaks.
+    """
+
+    new_messages = []
+
+    while True:
+        mbuf = rmr.rmr_alloc_msg(mrc, 4096)  # allocate buffer to have something for a return status
+        mbuf = rmr.rmr_torcv_msg(mrc, mbuf, 0)  # set the timeout to 0 so this doesn't block!!
+        summary = rmr.message_summary(mbuf)
+        if summary["message status"] != "RMR_OK":
+            break
+
+        if len(pass_filter) == 0 or mbuf.contents.mtype in pass_filter:  # no filter, or passes; capture it
+            new_messages.append((summary, mbuf))
         else:
-            if len(pass_filter) == 0 or summary["message type"] in pass_filter:      # no filter, or passes; capture it
-                new_messages.append(summary)
+            rmr.rmr_free_msg(mbuf)
 
-    rmr.rmr_free_msg(mbuf)            # must free message to avoid leak
     return new_messages