X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ricxappframe%2Frmr%2Frmr.py;h=00c4b258abe16917809367c545ce6905118b13e0;hb=bbc9028aa34ae48e7806596cd05fbe7a5bfd7fb8;hp=e29a5ded7542503b9f5cded309df92b3fc8e5491;hpb=db26ba217530985dbdcf739640c16c6cecd54a1d;p=ric-plt%2Fxapp-frame-py.git diff --git a/ricxappframe/rmr/rmr.py b/ricxappframe/rmr/rmr.py index e29a5de..00c4b25 100644 --- a/ricxappframe/rmr/rmr.py +++ b/ricxappframe/rmr/rmr.py @@ -34,11 +34,38 @@ def _get_rmr_constant(key: str, default=None): 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 """ val = get_constants().get(key, default) return val if isinstance(val, (type(None), bool, bytes, float, int, str)) else None +# argtypes and restype are important: +# https://stackoverflow.com/questions/24377845/ctype-why-specify-argtypes +def _wrap_rmr_function(funcname, restype, argtypes): + """ + 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 ] + + Returns + ------- + _FuncPointer: + Pointer to C library function +""" + func = rmr_c_lib.__getattr__(funcname) + func.restype = restype + func.argtypes = argtypes + return func + + ############## # PUBLIC API ############## @@ -53,10 +80,37 @@ RMRFL_MTCALL = _get_rmr_constant('RMRFL_MTCALL', 0x02) # initialization flags RMRFL_NONE = _get_rmr_constant('RMRFL_NONE', 0x0) #: State constant for OK RMR_OK = _get_rmr_constant('RMR_OK', 0x00) -#: State constant for timeout -RMR_ERR_TIMEOUT = _get_rmr_constant('RMR_ERR_TIMEOUT') +#: 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 = _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): @@ -74,7 +128,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 @@ -100,10 +154,7 @@ class rmr_mbuf_t(Structure): ] -# 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: @@ -135,9 +186,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: @@ -159,8 +208,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): @@ -182,9 +230,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: @@ -208,9 +254,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, @@ -281,9 +325,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]) # new_len, copy, clone def rmr_realloc_payload(ptr_mbuf: c_void_p, new_len: int, copy=False, clone=False): @@ -312,9 +354,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): @@ -337,9 +377,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: @@ -366,9 +404,7 @@ def rmr_payload_size(ptr_mbuf: c_void_p) -> int: 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): @@ -394,9 +430,7 @@ def rmr_send_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_m # 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): @@ -421,9 +455,7 @@ def rmr_rcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mb 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): @@ -450,9 +482,7 @@ def rmr_torcv_msg(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t), ms_to: int) -> 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): @@ -492,9 +522,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): @@ -517,9 +545,7 @@ def rmr_call(vctx: c_void_p, ptr_mbuf: POINTER(rmr_mbuf_t)) -> POINTER(rmr_mbuf_ 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: @@ -560,9 +586,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: @@ -588,9 +612,7 @@ def rmr_get_meid(ptr_mbuf: POINTER(rmr_mbuf_t)) -> bytes: 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: @@ -615,6 +637,24 @@ def rmr_get_src(ptr_mbuf: POINTER(rmr_mbuf_t), dest: c_char_p) -> c_char_p: return _rmr_get_src(ptr_mbuf, dest) +_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) + + # 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. @@ -660,30 +700,30 @@ def get_xaction(ptr_mbuf: c_void_p) -> bytes: 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, }