API and build change and fixe summaries. Doc correctsions
and/or changes are not mentioned here; see the commit messages.
+2019 September 27; version 1.9.0
+ Python bindings added receive all queued function and corrected a unit test
+
2019 September 25; version 1.8.3
Correct application level test issue causing timing problems during
jenkins verification testing at command and merge
cmake_minimum_required( VERSION 3.5 )
set( major_version "1" ) # should be automatically populated from git tag later, but until CI process sets a tag we use this
-set( minor_version "8" )
-set( patch_level "3" )
+set( minor_version "9" )
+set( patch_level "0" )
set( install_root "${CMAKE_INSTALL_PREFIX}" )
set( install_inc "include/rmr" )
and this project adheres to `Semantic
Versioning <http://semver.org/>`__.
+[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
--------------------
function signatures.
The downside is this seems to be Linux only currently. This wrapper
-immediately SIGABRT’s on Mac, and no one yet seems to know why. The
+immediately SIGABRT's on Mac, and no one yet seems to know why. The
other downside is that there are currently some functionality that needs
-to be “exported” from the C library for this to be fully operational.
+to be 'exported' from the C library for this to be fully operational.
For example, CTYPES does not have access to C header files, and
important constants are defined in the C header files.
--- /dev/null
+# vim: ts=4 sw=4 expandtab:
+# ==================================================================================
+# Copyright (c) 2019 Nokia
+# Copyright (c) 2018-2019 AT&T Intellectual Property.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==================================================================================
+
+# Mnemonic: rcv_all.py
+# Abstract: This example shows how to receive all queued messages into
+# a bunch (an array of summaries). RMR is initialised in multi-
+# threaded call mode so that it will queue messages on a 2K ring
+# and prevent the remote application(s) from blocking if we don't
+# do timely receives. Then we read 'bursts' of messages sleeping
+# between reads to allow some message to pile up.
+#
+# Because this programme does not send messages, there is no reason
+# to wait for RMR to initialise a route table (no call to rmr_ready
+# is needed.
+#
+# Date: 26 September 2019
+#
+# ---------------------------------------------------------------------------------
+
+from rmr import rmr
+from rmr import helpers
+import time
+import sys
+import signal
+
+
+# Ensure things terminate nicely
+#
+def signal_handler(sig, frame):
+ print('SIGINT received! Cleaning up rmr')
+ rmr.rmr_close(mrc)
+ print("Byeee")
+ sys.exit(0)
+
+listen_port = "4560".encode('utf-8') # port RMR will listen on (RMR needs string, not value)
+mrc = rmr.rmr_init( listen_port, rmr.RMR_MAX_RCV_BYTES, rmr.RMRFL_MTCALL ) # put into multi-threaded call mode
+
+signal.signal(signal.SIGINT, signal_handler) # cleanup on ctl-c
+
+while True:
+
+ # three calling options:
+ #mbunch = helpers.rmr_rcvall_msgs( mrc, [2, 4, 6] ) # get types 2, 4 and 6 only
+ #mbunch = helpers.rmr_rcvall_msgs( mrc, [2] ) # get types 2 only
+ mbunch = helpers.rmr_rcvall_msgs( mrc ) # get all message types
+
+ if mbunch == None or len( mbunch ) < 1:
+ print( "no messages" )
+ else:
+ print( "got %d messages" % len( mbunch ) )
+ for mb in mbunch:
+ print( "type=%d payload=%s" % (mb["message type"], mb["payload"] ) )
+
+ time.sleep( 1 ) # sleep to allow some to accumulate
+
--- /dev/null
+# vim: ts=4 sw=4 expandtab:
+# ==================================================================================
+# Copyright (c) 2019 Nokia
+# Copyright (c) 2018-2019 AT&T Intellectual Property.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==================================================================================
+
+# Mnemonic: helpers.py
+# Abstract: This is a colleciton of extensions to the RMR base package
+# which are likely to be convenient for python programmes.
+# Date: 26 September 2019
+# ---------------------------------------------------------------------------
+
+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.
+ """
+
+ new_messages = []
+ 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
+ break
+ 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) # must free message to avoid leak
+ return new_messages
return sdict.get(stateno, "UNKNOWN STATE")
+_RCONST = _get_constants()
+
+
##############
# PUBLIC API
##############
# These constants are directly usable by importers of this library
# TODO: Are there others that will be useful?
-RMR_MAX_RCV_BYTES = _get_constants()["RMR_MAX_RCV_BYTES"]
+
+RMR_MAX_RCV_BYTES = _RCONST["RMR_MAX_RCV_BYTES"]
+
+RMRFL_NONE = _RCONST.get("RMRFL_MTCALL", 0x02) # initialisation flags
+RMRFL_NONE = _RCONST.get("RMRFL_NONE", 0x0)
+
+RMR_OK = _RCONST["RMR_OK"] # useful state constants
+RMR_ERR_TIMEOUT = _RCONST["RMR_ERR_TIMEOUT"]
+RMR_ERR_RETRY = _RCONST["RMR_ERR_RETRY"]
class rmr_mbuf_t(Structure):
return _rmr_alloc_msg(vctx, size)
+_rmr_free_msg = rmr_c_lib.rmr_free_msg
+_rmr_free_msg.argtypes = [c_void_p]
+_rmr_free_msg.restype = None
+
+
+def rmr_free_msg(mbuf):
+ """
+ Refer to the rmr C documentation for rmr_free_msg
+ extern void rmr_free_msg( rmr_mbuf_t* mbuf )
+ """
+ if mbuf is not None:
+ _rmr_free_msg(mbuf)
+
+
_rmr_payload_size = rmr_c_lib.rmr_payload_size
_rmr_payload_size.argtypes = [POINTER(rmr_mbuf_t)]
_rmr_payload_size.restype = c_int
setup(
name="rmr",
- version="0.12.0",
+ version="0.13.0",
packages=find_packages(),
author="Tommy Carpenter, E. Scott Daniels",
description="Python wrapper for RIC RMR",
+# vim: ts=4 sw=4 expandtab:
# ==================================================================================
# Copyright (c) 2019 Nokia
# Copyright (c) 2018-2019 AT&T Intellectual Property.
# These are here just to reduce the size of the code in test_rmr so those (important) tests are more readable; in theory these dicts could be large
+# The actual value of the constants should be ignored by the tests; all we should care
+# about is that the constant value was returned by the RMR function. Further, we should
+# not consider it an error if RMR returns more than what is listed here; these are the
+# list of what is/could be used by this package.
@pytest.fixture
def expected_constants():
return {
"RMR_MAX_SRC": 64,
"RMR_MAX_RCV_BYTES": 4096,
"RMRFL_NONE": 0,
+ #"RMRFL_MTCALL": 2, #can't be added here until jenkins version >= 1.8.3
"RMRFL_AUTO_ALLOC": 3,
"RMR_DEF_SIZE": 0,
"RMR_VOID_MSGTYPE": -1,
-# ==================================================================================
+# vim: ts=4 sw=4 expandtab:
+# =================================================================================2
# Copyright (c) 2019 Nokia
# Copyright (c) 2018-2019 AT&T Intellectual Property.
#
def test_get_constants(expected_constants):
"""
- test getting constants
+ test getting constants. We don't care what values are returned as those
+ should be meaningful only to RMR. We do care that all of the constants
+ which are defined in expected_contents are returned. Further, we don't
+ consider it to be an error if the returned list has more constants than
+ what are in our list.
+
+ To avoid frustration, this should list all missing keys, not fail on the
+ first missing key.
"""
- assert rmr._get_constants() == expected_constants
+ errors = 0
+ econst = expected_constants
+ rconst = rmr._get_constants()
+ for key in econst: # test all expected constants
+ if key not in rconst: # expected value not listed by rmr
+ errors += 1
+ print( "did not find required constant in list from RMR: %s" % key )
+
+ assert errors == 0
def test_get_mapping_dict(expected_states):
Code Review / ric-plt / lib / rmr.git / commitdiff