X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=src%2Frmr%2Fcommon%2Finclude%2Frmr.h;h=cc2c0c8c2a8d9706036abc218a01fe1cdea243c5;hb=4d1f9bf4b14788f957964d93af940e84f8f01601;hp=e6c1660f1d42e705d067a39688620dd8ee000ce2;hpb=68c1ab2191d9959fde0bd275a560f7c9cf6df485;p=ric-plt%2Flib%2Frmr.git diff --git a/src/rmr/common/include/rmr.h b/src/rmr/common/include/rmr.h index e6c1660..cc2c0c8 100644 --- a/src/rmr/common/include/rmr.h +++ b/src/rmr/common/include/rmr.h @@ -36,14 +36,18 @@ extern "C" { #define RMR_MAX_XID 32 // space in header reserved for user xaction id -#define RMR_MAX_SID 32 // spece in header reserved for sender id #define RMR_MAX_MEID 32 // spece in header reserved for managed element id #define RMR_MAX_SRC 64 // max length of hostname (which could be IPv6 addr with [...]:port so more than the 39 bytes of a plain addr +#define RMR_MAX_SID 32 // misc sender info/data (reserved) #define RMR_MAX_RCV_BYTES 4096 // max bytes we support in a receive message // various flags for function calls #define RMRFL_NONE 0x00 // no flags -#define RMRFL_AUTO_ALLOC 0x01 // send auto allocates a zerocopy buffer +#define RMRFL_NOTHREAD 0x01 // do not start an additional route collector thread +#define RMRFL_MTCALL 0x02 // set up multi-threaded call support (rmr_init) +#define RMRFL_AUTO_ALLOC 0x03 // send auto allocates a zerocopy buffer +#define RMRFL_NAME_ONLY 0x04 // only the hostname:ip is provided as source information for rts() calls +#define RMRFL_NOLOCK 0x08 // disable receive ring locking (user app ensures single thread or provides collision protection) #define RMR_DEF_SIZE 0 // pass as size to have msg allocation use the default msg size @@ -66,6 +70,7 @@ extern "C" { #define RMR_ERR_UNSET 13 // the message hasn't been populated with a transport buffer #define RMR_ERR_TRUNC 14 // received message likely truncated #define RMR_ERR_INITFAILED 15 // initialisation of something (probably message) failed +#define RMR_ERR_NOTSUPP 16 // the request is not supported, or RMr was not initialised for the request #define RMR_WH_CONNECTED(a) (a>=0) // for now whid is integer; it could be pointer at some future date @@ -74,6 +79,14 @@ extern "C" { (All fields are exposed such that if a wrapper needs to dup the storage as it passes into or out of their environment they dup it all, not just what we choose to expose.) + + NOTE: + State is the RMR state of processing on the message. The transport state (tp_state) + will be set to mirror the value of errno for wrappers unable to access errno directly, + but will only be set if state is not RMR_OK. Even then, the value may be suspect as + the underlying transport mechanism may not set errno. It is strongly recommended that + user applications use tp_state only for dianostic purposes to convey additional information + in a log message. */ typedef struct { int state; // state of processing @@ -82,6 +95,7 @@ typedef struct { unsigned char* payload; // transported data unsigned char* xaction; // pointer to fixed length transaction id bytes int sub_id; // subscription id + int tp_state; // transport state (errno) valid only if state != RMR_OK, and even then may not be valid // these things are off limits to the user application void* tp_buf; // underlying transport allocated pointer (e.g. nng message) @@ -89,6 +103,11 @@ typedef struct { unsigned char* id; // if we need an ID in the message separate from the xaction id int flags; // various MFL_ (private) flags as needed int alloc_len; // the length of the allocated space (hdr+payload) + + void* ring; // ring this buffer should be queued back to + int rts_fd; // SI fd for return to sender + + int cookie; // cookie to detect user misuse of free'd msg } rmr_mbuf_t; @@ -99,6 +118,7 @@ typedef int rmr_whid_t; // wormhole identifier returned by rmr_wh_open(), pass extern rmr_mbuf_t* rmr_alloc_msg( void* vctx, int size ); extern rmr_mbuf_t* rmr_call( void* vctx, rmr_mbuf_t* msg ); extern void rmr_close( void* vctx ); +extern void rmr_set_fack( void* vctx ); extern void* rmr_init( char* proto_port, int max_msg_size, int flags ); extern int rmr_init_trace( void* vctx, int size ); extern int rmr_payload_size( rmr_mbuf_t* msg ); @@ -111,12 +131,17 @@ extern int rmr_ready( void* vctx ); extern int rmr_set_rtimeout( void* vctx, int time ); extern int rmr_set_stimeout( void* vctx, int time ); extern int rmr_get_rcvfd( void* vctx ); // only supported with nng +extern void rmr_set_low_latency( void* vctx ); extern rmr_mbuf_t* rmr_torcv_msg( void* vctx, rmr_mbuf_t* old_msg, int ms_to ); extern rmr_mbuf_t* rmr_tralloc_msg( void* context, int msize, int trsize, unsigned const char* data ); extern rmr_whid_t rmr_wh_open( void* vctx, char const* target ); extern rmr_mbuf_t* rmr_wh_send_msg( void* vctx, rmr_whid_t whid, rmr_mbuf_t* msg ); +extern int rmr_wh_state( void* vctx, rmr_whid_t whid ); extern void rmr_wh_close( void* vctx, int whid ); +// ----- mt call support -------------------------------------------------------------------------------- +extern rmr_mbuf_t* rmr_mt_call( void* vctx, rmr_mbuf_t* mbuf, int call_id, int max_wait ); +extern rmr_mbuf_t* rmr_mt_rcv( void* vctx, rmr_mbuf_t* mbuf, int max_wait ); // ----- msg buffer operations (no context needed) ------------------------------------------------------ extern int rmr_bytes2meid( rmr_mbuf_t* mbuf, unsigned char const* src, int len ); @@ -125,11 +150,15 @@ extern int rmr_bytes2xact( rmr_mbuf_t* mbuf, unsigned char const* src, int len ) extern void rmr_free_msg( rmr_mbuf_t* mbuf ); extern unsigned char* rmr_get_meid( rmr_mbuf_t* mbuf, unsigned char* dest ); extern unsigned char* rmr_get_src( rmr_mbuf_t* mbuf, unsigned char* dest ); +extern unsigned char* rmr_get_srcip( rmr_mbuf_t* msg, unsigned char* dest ); +extern unsigned char* rmr_get_xact( rmr_mbuf_t* mbuf, unsigned char* dest ); extern rmr_mbuf_t* rmr_realloc_msg( rmr_mbuf_t* mbuf, int new_tr_size ); +extern rmr_mbuf_t* rmr_realloc_payload( rmr_mbuf_t* old_msg, int new_len, int copy, int clone ); extern int rmr_str2meid( rmr_mbuf_t* mbuf, unsigned char const* str ); extern void rmr_str2payload( rmr_mbuf_t* mbuf, unsigned char const* str ); extern void rmr_str2payload( rmr_mbuf_t* mbuf, unsigned char const* str ); extern int rmr_str2xact( rmr_mbuf_t* mbuf, unsigned char const* str ); +extern void* rmr_trace_ref( rmr_mbuf_t* msg, int* sizeptr ); extern int rmr_get_trlen( rmr_mbuf_t* msg ); extern int rmr_get_trace( rmr_mbuf_t* msg, unsigned char* dest, int size ); @@ -138,6 +167,8 @@ extern int rmr_set_trace( rmr_mbuf_t* msg, unsigned const char* data, int size ) extern int rmr_rcv_to( void* vctx, int time ); // DEPRECATED -- replaced with set_rtimeout extern int rmr_send_to( void* vctx, int time ); // DEPRECATED -- replaced with set_stimeout +// ---- misc user interface stuff ---------------------------------------------------------------------- +extern void rmr_set_vlevel( int new_level ); // --- uta compatability defs if needed user should define UTA_COMPAT ---------------------------------- #ifdef UTA_COMPAT