X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ricxappframe%2Frmr%2Frmr.py;h=0e57200a2270f301b990d103116f69926ab988a2;hb=HEAD;hp=80617a7f9b4abdee58275f99a990735335052c43;hpb=4b9552c36d910264474a25cd7c1520a2a816f4d4;p=ric-plt%2Fxapp-frame-py.git diff --git a/ricxappframe/rmr/rmr.py b/ricxappframe/rmr/rmr.py index 80617a7..0e57200 100644 --- a/ricxappframe/rmr/rmr.py +++ b/ricxappframe/rmr/rmr.py @@ -14,108 +14,106 @@ # See the License for the specific language governing permissions and # limitations under the License. # ================================================================================== +""" +Wraps all RMR functions, but does not have a reference to the shared library. +""" import uuid -import json -from ctypes import CDLL, POINTER, RTLD_GLOBAL, Structure -from ctypes import c_char, c_char_p, c_int, c_void_p, cast, create_string_buffer, memmove +from ctypes import POINTER, Structure +from ctypes import c_int, c_char, c_char_p, c_void_p, memmove, cast, create_string_buffer from ricxappframe.rmr.exceptions import BadBufferAllocation, MeidSizeOutOfRange, InitFailed +from ricxappframe.rmr.rmrclib.rmrclib import rmr_c_lib, get_constants, state_to_status -# https://docs.python.org/3.7/library/ctypes.html -# https://stackoverflow.com/questions/2327344/ctypes-loading-a-c-shared-library-that-has-dependencies/30845750#30845750 -# make sure you do a set -x LD_LIBRARY_PATH /usr/local/lib/; -rmr_c_lib = CDLL("librmr_si.so", mode=RTLD_GLOBAL) - - -# Internal Helpers (not a part of public api) - - -_rmr_const = rmr_c_lib.rmr_get_consts -_rmr_const.argtypes = [] -_rmr_const.restype = c_char_p - - -def _get_constants(cache={}) -> dict: - """ - Gets constants published by RMR and caches for subsequent calls. - TODO: are there constants that end user applications need? - """ - if cache: - return cache - - js = _rmr_const() # read json string - cache = json.loads(str(js.decode())) # create constants value object as a hash - return cache +############## +# PRIVATE API +############## -def _get_mapping_dict(cache={}) -> dict: +def _get_rmr_constant(key: str, default=None): """ - Builds a state mapping dict from constants and caches for subsequent calls. - Relevant constants at this writing include: - - RMR_OK 0 state is good - RMR_ERR_BADARG 1 argument passd to function was unusable - RMR_ERR_NOENDPT 2 send/call could not find an endpoint based on msg type - RMR_ERR_EMPTY 3 msg received had no payload; attempt to send an empty message - RMR_ERR_NOHDR 4 message didn't contain a valid header - RMR_ERR_SENDFAILED 5 send failed; errno has nano reason - RMR_ERR_CALLFAILED 6 unable to send call() message - RMR_ERR_NOWHOPEN 7 no wormholes are open - RMR_ERR_WHID 8 wormhole id was invalid - RMR_ERR_OVERFLOW 9 operation would have busted through a buffer/field size - RMR_ERR_RETRY 10 request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers) - RMR_ERR_RCVFAILED 11 receive failed (hard error) - RMR_ERR_TIMEOUT 12 message processing call timed out - RMR_ERR_UNSET 13 the message hasn't been populated with a transport buffer - RMR_ERR_TRUNC 14 received message likely truncated - RMR_ERR_INITFAILED 15 initialization of something (probably message) failed - + Gets the constant with the named key from the RMR C library. + Returns None if the value is not a simple type. This happens + during sphinx autodoc document generation, which mocks the + rmrclib package to work without the RMR shared object file, + and the response is something like this: + + Workaround for https://github.com/sphinx-doc/sphinx/issues/7422 """ - if cache: - return cache - - rmr_consts = _get_constants() - for key in rmr_consts: # build the state mapping dict - if key[:7] in ["RMR_ERR", "RMR_OK"]: - en = int(rmr_consts[key]) - cache[en] = key - - return cache - + val = get_constants().get(key, default) + return val if isinstance(val, (type(None), bool, bytes, float, int, str)) else None -def _state_to_status(stateno: int) -> str: - """ - Converts a msg state integer to a status string. - Returns "UNKNOWN STATE" if the int value is not known. +# argtypes and restype are important: +# https://stackoverflow.com/questions/24377845/ctype-why-specify-argtypes +def _wrap_rmr_function(funcname, restype, argtypes): """ - sdict = _get_mapping_dict() - return sdict.get(stateno, "UNKNOWN STATE") + Simplify wrapping ctypes functions. + Parameters + ---------- + funcname: str + Name of library method + restype: class + Name of ctypes class; e.g., c_char_p + argtypes: list + List of ctypes classes; e.g., [ c_char_p, int ] -_RCONST = _get_constants() + Returns + ------- + _FuncPointer: + Pointer to C library function +""" + func = rmr_c_lib.__getattr__(funcname) + func.restype = restype + func.argtypes = argtypes + return func ############## # PUBLIC API ############## - -# These constants are directly usable by importers of this library +# Publish constants from RMR C-language header files for use by importers of this library. # TODO: Are there others that will be useful? - -#: Maximum size message to receive -RMR_MAX_RCV_BYTES = _RCONST["RMR_MAX_RCV_BYTES"] +#: Typical size message to receive; size is not limited +RMR_MAX_RCV_BYTES = _get_rmr_constant('RMR_MAX_RCV_BYTES') #: Multi-threaded initialization flag -RMRFL_MTCALL = _RCONST.get("RMRFL_MTCALL", 0x02) # initialization flags +RMRFL_MTCALL = _get_rmr_constant('RMRFL_MTCALL', 0x02) # initialization flags #: Empty flag -RMRFL_NONE = _RCONST.get("RMRFL_NONE", 0x0) +RMRFL_NONE = _get_rmr_constant('RMRFL_NONE', 0x0) #: State constant for OK -RMR_OK = _RCONST["RMR_OK"] -#: State constant for timeout -RMR_ERR_TIMEOUT = _RCONST["RMR_ERR_TIMEOUT"] +RMR_OK = _get_rmr_constant('RMR_OK', 0x00) +#: State constant for no endpoint based on msg type +RMR_ERR_NOENDPT = _get_rmr_constant('RMR_ERR_NOENDPT') #: State constant for retry -RMR_ERR_RETRY = _RCONST["RMR_ERR_RETRY"] +RMR_ERR_RETRY = _get_rmr_constant('RMR_ERR_RETRY') +#: State constant for timeout +RMR_ERR_TIMEOUT = _get_rmr_constant('RMR_ERR_TIMEOUT') + +# Publish keys used in the message summary dict as constants + +# message payload, bytes +RMR_MS_PAYLOAD = "payload" +# payload length, integer +RMR_MS_PAYLOAD_LEN = "payload length" +# message type, integer +RMR_MS_MSG_TYPE = "message type" +# subscription ID, integer +RMR_MS_SUB_ID = "subscription id" +# transaction ID, bytes +RMR_MS_TRN_ID = "transaction id" +# state of message processing, integer; e.g., 0 +RMR_MS_MSG_STATE = "message state" +# state of message processing converted to string; e.g., RMR_OK +RMR_MS_MSG_STATUS = "message status" +# number of bytes usable in the payload, integer +RMR_MS_PAYLOAD_MAX = "payload max size" +# managed entity ID, bytes +RMR_MS_MEID = "meid" +# message source, string; e.g., host:port +RMR_MS_MSG_SOURCE = "message source" +# transport state, integer +RMR_MS_ERRNO = "errno" class rmr_mbuf_t(Structure): @@ -133,7 +131,7 @@ class rmr_mbuf_t(Structure): | | these things are off limits to the user application | - | void* tp_buf; // underlying transport allocated pointer (e.g. nng message) + | void* tp_buf; // underlying transport allocated pointer | void* header; // internal message header (whole buffer: header+payload) | unsigned char* id; // if we need an ID in the message separate from the xaction id | int flags; // various MFL (private) flags as needed @@ -146,25 +144,20 @@ class rmr_mbuf_t(Structure): For a general character pointer that may also point to binary data, POINTER(c_char) must be used. The constructor accepts an integer address, or a bytes object. """ - + # re payload, according to the following the python bytes are already unsigned: + # https://bytes.com/topic/python/answers/695078-ctypes-unsigned-char _fields_ = [ ("state", c_int), ("mtype", c_int), ("len", c_int), - ("payload", POINTER(c_char)), # according to the following the python bytes are already unsigned - # https://bytes.com/topic/python/answers/695078-ctypes-unsigned-char + ("payload", POINTER(c_char)), ("xaction", POINTER(c_char)), ("sub_id", c_int), ("tp_state", c_int), ] -# argtypes and restype are important: https://stackoverflow.com/questions/24377845/ctype-why-specify-argtypes - - -_rmr_init = rmr_c_lib.rmr_init -_rmr_init.argtypes = [c_char_p, c_int, c_int] -_rmr_init.restype = c_void_p +_rmr_init = _wrap_rmr_function('rmr_init', c_void_p, [c_char_p, c_int, c_int]) def rmr_init(uproto_port: c_char_p, max_msg_size: int, flags: int) -> c_void_p: @@ -196,9 +189,7 @@ def rmr_init(uproto_port: c_char_p, max_msg_size: int, flags: int) -> c_void_p: return mrc -_rmr_ready = rmr_c_lib.rmr_ready -_rmr_ready.argtypes = [c_void_p] -_rmr_ready.restype = c_int +_rmr_ready = _wrap_rmr_function('rmr_ready', c_int, [c_void_p]) def rmr_ready(vctx: c_void_p) -> int: @@ -220,8 +211,7 @@ def rmr_ready(vctx: c_void_p) -> int: return _rmr_ready(vctx) -_rmr_close = rmr_c_lib.rmr_close -_rmr_close.argtypes = [c_void_p] +_rmr_close = _wrap_rmr_function('rmr_close', None, [c_void_p]) def rmr_close(vctx: c_void_p): @@ -243,9 +233,7 @@ def rmr_close(vctx: c_void_p): _rmr_close(vctx) -_rmr_set_stimeout = rmr_c_lib.rmr_set_stimeout -_rmr_set_stimeout.argtypes = [c_void_p, c_int] -_rmr_set_stimeout.restype = c_int +_rmr_set_stimeout = _wrap_rmr_function('rmr_set_stimeout', c_int, [c_void_p, c_int]) def rmr_set_stimeout(vctx: c_void_p, rloops: int) -> int: @@ -269,9 +257,7 @@ def rmr_set_stimeout(vctx: c_void_p, rloops: int) -> int: return _rmr_set_stimeout(vctx, rloops) -_rmr_alloc_msg = rmr_c_lib.rmr_alloc_msg -_rmr_alloc_msg.argtypes = [c_void_p, c_int] -_rmr_alloc_msg.restype = POINTER(rmr_mbuf_t) +_rmr_alloc_msg = _wrap_rmr_function('rmr_alloc_msg', POINTER(rmr_mbuf_t), [c_void_p, c_int]) def rmr_alloc_msg(vctx: c_void_p, size: int, @@ -342,9 +328,7 @@ def rmr_alloc_msg(vctx: c_void_p, size: int, raise BadBufferAllocation -_rmr_realloc_payload = rmr_c_lib.rmr_realloc_payload -_rmr_realloc_payload.argtypes = [POINTER(rmr_mbuf_t), c_int, c_int, c_int] # new_len, copy, clone -_rmr_realloc_payload.restype = POINTER(rmr_mbuf_t) +_rmr_realloc_payload = _wrap_rmr_function('rmr_realloc_payload', POINTER(rmr_mbuf_t), [POINTER(rmr_mbuf_t), c_int, c_int, c_int]) def rmr_realloc_payload(ptr_mbuf: c_void_p, new_len: int, copy=False, clone=False): @@ -373,9 +357,7 @@ def rmr_realloc_payload(ptr_mbuf: c_void_p, new_len: int, copy=False, clone=Fals return _rmr_realloc_payload(ptr_mbuf, new_len, copy, clone) -_rmr_free_msg = rmr_c_lib.rmr_free_msg -_rmr_free_msg.argtypes = [POINTER(rmr_mbuf_t)] -_rmr_free_msg.restype = None +_rmr_free_msg = _wrap_rmr_function('rmr_free_msg', None, [POINTER(rmr_mbuf_t)]) def rmr_free_msg(ptr_mbuf: c_void_p): @@ -398,9 +380,7 @@ def rmr_free_msg(ptr_mbuf: c_void_p): _rmr_free_msg(ptr_mbuf) -_rmr_payload_size = rmr_c_lib.rmr_payload_size -_rmr_payload_size.argtypes = [POINTER(rmr_mbuf_t)] -_rmr_payload_size.restype = c_int +_rmr_payload_size = _wrap_rmr_function('rmr_payload_size', c_int, [POINTER(rmr_mbuf_t)]) def rmr_payload_size(ptr_mbuf: c_void_p) -> int: @@ -408,7 +388,7 @@ def rmr_payload_size(ptr_mbuf: c_void_p) -> int: Gets the number of bytes available in the payload. Refer to RMR C documentation for method:: - extern int rmr_payload_size(rmr_mbuf_t* msg) + extern int rmr_payload_size(rmr_mbuf_t* mbuf) Parameters ---------- @@ -423,13 +403,7 @@ def rmr_payload_size(ptr_mbuf: c_void_p) -> int: return _rmr_payload_size(ptr_mbuf) -""" -The following functions all seem to have the same interface -""" - -_rmr_send_msg = rmr_c_lib.rmr_send_msg -_rmr_send_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t)] -_rmr_send_msg.restype = POINTER(rmr_mbuf_t) +_rmr_send_msg = _wrap_rmr_function('rmr_send_msg', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t)]) def rmr_send_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_t): @@ -437,7 +411,7 @@ def rmr_send_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_m Sends the message according to the routing table and returns an empty buffer. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_send_msg(void* vctx, rmr_mbuf_t* msg) + extern rmr_mbuf_t* rmr_send_msg(void* vctx, rmr_mbuf_t* mbuf) Parameters ---------- @@ -448,16 +422,14 @@ def rmr_send_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_m Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ return _rmr_send_msg(vctx, ptr_mbuf) # TODO: the old message (Send param) is actually optional, but I don't know how to specify that in Ctypes. -_rmr_rcv_msg = rmr_c_lib.rmr_rcv_msg -_rmr_rcv_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t)] -_rmr_rcv_msg.restype = POINTER(rmr_mbuf_t) +_rmr_rcv_msg = _wrap_rmr_function('rmr_rcv_msg', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t)]) def rmr_rcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_t): @@ -465,7 +437,7 @@ def rmr_rcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mb Waits for a message to arrive, and returns it. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_rcv_msg(void* vctx, rmr_mbuf_t* old_msg) + extern rmr_mbuf_t* rmr_rcv_msg(void* vctx, rmr_mbuf_t* old_mbuf) Parameters ---------- @@ -476,15 +448,13 @@ def rmr_rcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mb Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ return _rmr_rcv_msg(vctx, ptr_mbuf) -_rmr_torcv_msg = rmr_c_lib.rmr_torcv_msg -_rmr_torcv_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t), c_int] -_rmr_torcv_msg.restype = POINTER(rmr_mbuf_t) +_rmr_torcv_msg = _wrap_rmr_function('rmr_torcv_msg', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t), c_int]) def rmr_torcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), ms_to: int) -> POINTER(rmr_mbuf_t): @@ -492,7 +462,7 @@ def rmr_torcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), ms_to: int) -> Waits up to the timeout value for a message to arrive, and returns it. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_torcv_msg(void* vctx, rmr_mbuf_t* old_msg, int ms_to) + extern rmr_mbuf_t* rmr_torcv_msg(void* vctx, rmr_mbuf_t* old_mbuf, int ms_to) Parameters ---------- @@ -505,15 +475,13 @@ def rmr_torcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), ms_to: int) -> Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ return _rmr_torcv_msg(vctx, ptr_mbuf, ms_to) -_rmr_rts_msg = rmr_c_lib.rmr_rts_msg -_rmr_rts_msg.argtypes = [c_void_p, POINTER(rmr_mbuf_t)] -_rmr_rts_msg.restype = POINTER(rmr_mbuf_t) +_rmr_rts_msg = _wrap_rmr_function('rmr_rts_msg', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t)]) def rmr_rts_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), payload=None, mtype=None) -> POINTER(rmr_mbuf_t): @@ -521,7 +489,7 @@ def rmr_rts_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), payload=None, mty Sends a message to the originating endpoint and returns an empty buffer. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_rts_msg(void* vctx, rmr_mbuf_t* msg) + extern rmr_mbuf_t* rmr_rts_msg(void* vctx, rmr_mbuf_t* mbuf) additional features beyond c-rmr: if payload is not None, attempts to set the payload @@ -540,7 +508,7 @@ def rmr_rts_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), payload=None, mty Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ @@ -553,9 +521,7 @@ def rmr_rts_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), payload=None, mty return _rmr_rts_msg(vctx, ptr_mbuf) -_rmr_call = rmr_c_lib.rmr_call -_rmr_call.argtypes = [c_void_p, POINTER(rmr_mbuf_t)] -_rmr_call.restype = POINTER(rmr_mbuf_t) +_rmr_call = _wrap_rmr_function('rmr_call', POINTER(rmr_mbuf_t), [c_void_p, POINTER(rmr_mbuf_t)]) def rmr_call(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_t): @@ -563,7 +529,7 @@ def rmr_call(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_ Sends a message, waits for a response and returns it. Refer to RMR C documentation for method:: - extern rmr_mbuf_t* rmr_call(void* vctx, rmr_mbuf_t* msg) + extern rmr_mbuf_t* rmr_call(void* vctx, rmr_mbuf_t* mbuf) Parameters ---------- @@ -572,15 +538,13 @@ def rmr_call(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_ Returns ------- - c_void_p: + ctypes c_void_p: Pointer to rmr_mbuf structure """ return _rmr_call(vctx, ptr_mbuf) -_rmr_bytes2meid = rmr_c_lib.rmr_bytes2meid -_rmr_bytes2meid.argtypes = [POINTER(rmr_mbuf_t), c_char_p, c_int] -_rmr_bytes2meid.restype = c_int +_rmr_bytes2meid = _wrap_rmr_function('rmr_bytes2meid', c_int, [POINTER(rmr_mbuf_t), c_char_p, c_int]) def rmr_set_meid(ptr_mbuf: POINTER(rmr_mbuf_t), byte_str: bytes) -> int: @@ -598,7 +562,7 @@ def rmr_set_meid(ptr_mbuf: POINTER(rmr_mbuf_t), byte_str: bytes) -> int: Parameters ---------- ptr_mbuf: ctypes c_void_p - Pointer to an RMR message buffer + Pointer to rmr_mbuf structure byte_tr: bytes Managed entity ID value @@ -607,8 +571,8 @@ def rmr_set_meid(ptr_mbuf: POINTER(rmr_mbuf_t), byte_str: bytes) -> int: int: number of bytes copied """ - max = _get_constants().get("RMR_MAX_MEID", 32) - if len(byte_str) >= max: + max_meid = _get_rmr_constant("RMR_MAX_MEID", 32) + if len(byte_str) >= max_meid: raise MeidSizeOutOfRange return _rmr_bytes2meid(ptr_mbuf, byte_str, len(byte_str)) @@ -621,9 +585,7 @@ def rmr_set_meid(ptr_mbuf: POINTER(rmr_mbuf_t), byte_str: bytes) -> int: # extern unsigned char* rmr_get_meid(rmr_mbuf_t* mbuf, unsigned char* dest); # we don't provide direct access to this function (unless it is asked for) because it is not really useful to provide your own buffer. # Rather, rmr_get_meid does this for you, and just returns the string. -_rmr_get_meid = rmr_c_lib.rmr_get_meid -_rmr_get_meid.argtypes = [POINTER(rmr_mbuf_t), c_char_p] -_rmr_get_meid.restype = c_char_p +_rmr_get_meid = _wrap_rmr_function('rmr_get_meid', c_char_p, [POINTER(rmr_mbuf_t), c_char_p]) def rmr_get_meid(ptr_mbuf: POINTER(rmr_mbuf_t)) -> bytes: @@ -636,22 +598,20 @@ def rmr_get_meid(ptr_mbuf: POINTER(rmr_mbuf_t)) -> bytes: Parameters ---------- ptr_mbuf: ctypes c_void_p - Pointer to an RMR message buffer + Pointer to rmr_mbuf structure Returns ------- bytes: Managed entity ID """ - sz = _get_constants().get("RMR_MAX_MEID", 32) # size for buffer to fill - buf = create_string_buffer(sz) + max_meid = _get_rmr_constant("RMR_MAX_MEID", 32) # size for buffer to fill + buf = create_string_buffer(max_meid) _rmr_get_meid(ptr_mbuf, buf) return buf.value -_rmr_get_src = rmr_c_lib.rmr_get_src -_rmr_get_src.argtypes = [POINTER(rmr_mbuf_t), c_char_p] -_rmr_get_src.restype = c_char_p +_rmr_get_src = _wrap_rmr_function('rmr_get_src', c_char_p, [POINTER(rmr_mbuf_t), c_char_p]) def rmr_get_src(ptr_mbuf: POINTER(rmr_mbuf_t), dest: c_char_p) -> c_char_p: @@ -664,7 +624,7 @@ def rmr_get_src(ptr_mbuf: POINTER(rmr_mbuf_t), dest: c_char_p) -> c_char_p: Parameters ---------- ptr_mbuf: ctypes POINTER(rmr_mbuf_t) - Pointer to an RMR message buffer + Pointer to rmr_mbuf structure dest: ctypes c_char_p Pointer to a buffer to receive the message source @@ -676,8 +636,157 @@ def rmr_get_src(ptr_mbuf: POINTER(rmr_mbuf_t), dest: c_char_p) -> c_char_p: return _rmr_get_src(ptr_mbuf, dest) -# Methods that exist ONLY in rmr-python, and are not wrapped methods -# In hindsight, I wish i put these in a separate module, but leaving this here to prevent api breakage. +_rmr_set_vlevel = _wrap_rmr_function('rmr_set_vlevel', None, [c_int]) + + +def rmr_set_vlevel(new_level: c_int): + """ + Sets the verbosity level which determines the messages RMR writes to standard error. + Refer to RMR C documentation for method:: + + void rmr_set_vlevel( int new_level ) + + Parameters + ---------- + new_level: int + New logging verbosity level, an integer in the range 0 (none) to 5 (debug). + """ + _rmr_set_vlevel(new_level) + + +_rmr_wh_call = _wrap_rmr_function('rmr_wh_call', POINTER(rmr_mbuf_t), [c_void_p, c_int, POINTER(rmr_mbuf_t), c_int, c_int]) + + +def rmr_wh_call(vctx: c_void_p, whid: c_int, ptr_mbuf: POINTER(rmr_mbuf_t), call_id: c_int, max_wait: c_int) -> POINTER(rmr_mbuf_t): + """ + Sends a message buffer (msg) using a wormhole ID (whid) and waits for a response. + Refer to RMR C documentation for method:: + + rmr_mbuf_t* rmr_wh_call( void* vctx, rmr_whid_t whid, rmr_mbuf_t* mbuf, int call_id, int max_wait ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + whid: c_int + Wormhole ID returned by rmr_wh_open + ptr_mbuf: ctypes POINTER(rmr_mbuf_t) + Pointer to rmr_mbuf structure + call_id: c_int + number in the range of 2..255 to identify the caller + max_wait: c_int + number of milliseconds to wait for a reply + + Returns + ------- + ctypes c_void_p: + Pointer to rmr_mbuf structure + """ + return _rmr_wh_call(vctx, whid, ptr_mbuf, call_id, max_wait) + + +_rmr_wh_close = _wrap_rmr_function('rmr_wh_close', None, [c_void_p, c_int]) + + +def rmr_wh_close(vctx: c_void_p, whid: c_int): + """ + Closes the wormhole associated with the wormhole id. + Refer to RMR C documentation for method:: + + void rmr_close( void* vctx, rmr_whid_t whid ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + whid: c_int + Wormhole ID returned by rmr_wh_open + """ + _rmr_wh_close(vctx, whid) + + +_rmr_wh_open = _wrap_rmr_function('rmr_wh_open', c_int, [c_void_p, c_char_p]) + + +def rmr_wh_open(vctx: c_void_p, target: c_char_p) -> c_int: + """ + Creates a direct link for sending to another RMR based process. + Refer to RMR C documentation for method:: + + rmr_whid_t rmr_wh_open( void* vctx, char* target ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + target: str + Pointer to bytes built from the target process host name and port number + as a string; e.g., b'localhost:4550' + + Returns + ------- + c_int: + Wormhole ID + """ + return _rmr_wh_open(vctx, target) + + +_rmr_wh_send_msg = _wrap_rmr_function('rmr_wh_send_msg', POINTER(rmr_mbuf_t), [c_void_p, c_int, POINTER(rmr_mbuf_t)]) + + +def rmr_wh_send_msg(vctx: c_void_p, whid: c_int, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_t): + """ + Sends a message buffer (msg) using a wormhole ID (whid). + Refer to RMR C documentation for method:: + + rmr_mbuf_t* rmr_wh_send_msg( void* vctx, rmr_whid_t id, rmr_mbuf_t* msg ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + whid: c_int + Wormhole ID returned by rmr_wh_open + ptr_mbuf: ctypes POINTER(rmr_mbuf_t) + Pointer to rmr_mbuf structure + + Returns + ------- + ctypes POINTER(rmr_mbuf_t): + Pointer to rmr_mbuf structure + """ + return _rmr_wh_send_msg(vctx, whid, ptr_mbuf) + + +_rmr_wh_state = _wrap_rmr_function('rmr_wh_state', c_int, [c_void_p, c_int]) + + +def rmr_wh_state(vctx: c_void_p, whid: c_int) -> c_int: + """ + Gets the state of the connection associated with the given wormhole (whid). + Refer to RMR C documentation for method:: + + int rmr_wh_state( void* vctx, rmr_whid_t whid ) + + Parameters + ---------- + vctx: ctypes c_void_p + Pointer to RMR context + whid: c_int + Wormhole ID returned by rmr_wh_open + + Returns + ------- + c_int: + State of the connection + """ + return _rmr_wh_state(vctx, whid, whid) + + +######################################################################################## +# Methods that exist ONLY in rmr-python, and are not wrapped methods. +# These should have been in a separate module, but leaving here to prevent api breakage. +######################################################################################## def get_payload(ptr_mbuf: c_void_p) -> bytes: @@ -694,10 +803,11 @@ def get_payload(ptr_mbuf: c_void_p) -> bytes: bytes: the message payload """ - # Logic came from the answer here: https://stackoverflow.com/questions/55103298/python-ctypes-read-pointerc-char-in-python - sz = ptr_mbuf.contents.len - CharArr = c_char * sz - return CharArr(*ptr_mbuf.contents.payload[:sz]).raw + # Logic came from the answer here: + # https://stackoverflow.com/questions/55103298/python-ctypes-read-pointerc-char-in-python + length = ptr_mbuf.contents.len + char_arr = c_char * length + return char_arr(*ptr_mbuf.contents.payload[:length]).raw def get_xaction(ptr_mbuf: c_void_p) -> bytes: @@ -715,36 +825,36 @@ def get_xaction(ptr_mbuf: c_void_p) -> bytes: the transaction id """ val = cast(ptr_mbuf.contents.xaction, c_char_p).value - sz = _get_constants().get("RMR_MAX_XID", 0) - return val[:sz] + max_xid = _get_rmr_constant("RMR_MAX_XID", 0) + return val[:max_xid] def message_summary(ptr_mbuf: c_void_p) -> dict: """ - Returns a dict with the fields of an RMR message. + Builds a dict with the contents of an RMR message. Parameters ---------- ptr_mbuf: ctypes c_void_p - Pointer to an rmr message buffer + Pointer to an RMR message buffer Returns ------- dict: - dict message summary + Message content as key-value pairs; keys are defined as RMR_MS_* constants. """ return { - "payload": get_payload(ptr_mbuf) if ptr_mbuf.contents.state == RMR_OK else None, - "payload length": ptr_mbuf.contents.len, - "message type": ptr_mbuf.contents.mtype, - "subscription id": ptr_mbuf.contents.sub_id, - "transaction id": get_xaction(ptr_mbuf), - "message state": ptr_mbuf.contents.state, - "message status": _state_to_status(ptr_mbuf.contents.state), - "payload max size": rmr_payload_size(ptr_mbuf), - "meid": rmr_get_meid(ptr_mbuf), - "message source": get_src(ptr_mbuf), - "errno": ptr_mbuf.contents.tp_state, + RMR_MS_PAYLOAD: get_payload(ptr_mbuf) if ptr_mbuf.contents.state == RMR_OK else None, + RMR_MS_PAYLOAD_LEN: ptr_mbuf.contents.len, + RMR_MS_MSG_TYPE: ptr_mbuf.contents.mtype, + RMR_MS_SUB_ID: ptr_mbuf.contents.sub_id, + RMR_MS_TRN_ID: get_xaction(ptr_mbuf), + RMR_MS_MSG_STATE: ptr_mbuf.contents.state, + RMR_MS_MSG_STATUS: state_to_status(ptr_mbuf.contents.state), + RMR_MS_PAYLOAD_MAX: rmr_payload_size(ptr_mbuf), + RMR_MS_MEID: rmr_get_meid(ptr_mbuf), + RMR_MS_MSG_SOURCE: get_src(ptr_mbuf), + RMR_MS_ERRNO: ptr_mbuf.contents.tp_state, } @@ -794,8 +904,8 @@ def set_transaction_id(ptr_mbuf: c_void_p, tid_bytes: bytes): tid_bytes: bytes bytes of the desired transaction id """ - sz = _get_constants().get("RMR_MAX_XID", 0) - memmove(ptr_mbuf.contents.xaction, tid_bytes, sz) + max_xid = _get_rmr_constant("RMR_MAX_XID", 0) + memmove(ptr_mbuf.contents.xaction, tid_bytes, max_xid) def get_src(ptr_mbuf: c_void_p) -> str: @@ -812,7 +922,7 @@ def get_src(ptr_mbuf: c_void_p) -> str: string: message source """ - sz = _get_constants().get("RMR_MAX_SRC", 64) # size to fill - buf = create_string_buffer(sz) + max_src = _get_rmr_constant("RMR_MAX_SRC", 64) # size to fill + buf = create_string_buffer(max_src) rmr_get_src(ptr_mbuf, buf) return buf.value.decode()