X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_bytes2meid.3.rst;h=f9e1df65da15515a97ea0a6b403ea3c7f3df7e1d;hb=3bcce7bf0dfe8dbe501cd8a851350acb23a3b6de;hp=b44e0833f80be4081e3ad04843a1d8e13ed1a8d9;hpb=5a9d175bb17fcc71aa19fc23458e485830b97e0a;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_bytes2meid.3.rst b/docs/rmr_bytes2meid.3.rst index b44e083..f9e1df6 100644 --- a/docs/rmr_bytes2meid.3.rst +++ b/docs/rmr_bytes2meid.3.rst @@ -1,85 +1,97 @@ - - -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 -.. CAUTION: this document is generated from source in doc/src/rtd. -.. To make changes edit the source and recompile the document. -.. Do NOT make changes directly to .rst or .md files. - - -============================================================================================ -Man Page: rmr_bytes2meid -============================================================================================ - -RMR Library Functions -============================================================================================ - - -NAME --------------------------------------------------------------------------------------------- - -rmr_bytes2meid - -SYNOPSIS --------------------------------------------------------------------------------------------- - - -:: - - #include - int rmr_bytes2meid( rmr_mbuf_t* mbuf, unsigned char* src, int len ) - - - -DESCRIPTION --------------------------------------------------------------------------------------------- - -The rmr_bytes2meid function will copy up to *len* bytes from -*src* to the managed entity ID (meid) field in the message. -The field is a fixed length, gated by the constant -RMR_MAX_MEID and if len is larger than this value, only -RMR_MAX_MEID bytes will actually be copied. - -RETURN VALUE --------------------------------------------------------------------------------------------- - -On success, the actual number of bytes copied is returned, or --1 to indicate a hard error. If the length is less than 0, or -not the same as length passed in, errno is set to one of the -errors described in the *Errors* section. - -ERRORS --------------------------------------------------------------------------------------------- - -If the returned length does not match the length passed in, -errno will be set to one of the following constants with the -meaning listed below. - - - -EINVAL - - The message, or an internal portion of the message, was - corrupted or the pointer was invalid. - - -EOVERFLOW - - The length passed in was larger than the maximum length of - the field; only a portion of the source bytes were copied. - - -EXAMPLE --------------------------------------------------------------------------------------------- - - -SEE ALSO --------------------------------------------------------------------------------------------- - -rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_call(3), -rmr_free_msg(3), rmr_get_rcvfd(3), rmr_get_meid(3), -rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), -rmr_rcv_specific(3), rmr_rts_msg(3), rmr_ready(3), -rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3), -rmr_ring_free(3), rmr_str2meid(3), rmr_str2xact(3), -rmr_wh_open(3), rmr_wh_send_msg(3) +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. CAUTION: this document is generated from source in doc/src/rtd. +.. To make changes edit the source and recompile the document. +.. Do NOT make changes directly to .rst or .md files. + +============================================================================================ +Man Page: rmr_bytes2meid +============================================================================================ + + + + +RMR LIBRARY FUNCTIONS +===================== + + + +NAME +---- + +rmr_bytes2meid + + +SYNOPSIS +-------- + + +:: + + #include + + int rmr_bytes2meid( rmr_mbuf_t* mbuf, unsigned char* src, int len ) + + + +DESCRIPTION +----------- + +The ``rmr_bytes2meid`` function will copy up to *len* bytes +from *src* to the managed entity ID (meid) field in the +message. The field is a fixed length, gated by the constant +``RMR_MAX_MEID`` and if len is larger than this value, only +RMR_MAX_MEID bytes will actually be copied. + + +RETURN VALUE +------------ + +On success, the actual number of bytes copied is returned, or +-1 to indicate a hard error. If the length is less than 0, or +not the same as length passed in, ``errno`` is set to one of +the errors described in the *Errors* section. + + +ERRORS +------ + +If the returned length does not match the length passed in, +``errno`` will be set to one of the following constants with +the meaning listed below. + + .. list-table:: + :widths: auto + :header-rows: 0 + :class: borderless + + + * - **EINVAL** + - + The message, or an internal portion of the message, was + corrupted or the pointer was invalid. + + + * - **EOVERFLOW** + - + The length passed in was larger than the maximum length of + the field; only a portion of the source bytes were copied. + + + + +EXAMPLE +------- + + + +SEE ALSO +-------- + +rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_call(3), +rmr_free_msg(3), rmr_get_rcvfd(3), rmr_get_meid(3), +rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), +rmr_rcv_specific(3), rmr_rts_msg(3), rmr_ready(3), +rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3), +rmr_ring_free(3), rmr_str2meid(3), rmr_str2xact(3), +rmr_wh_open(3), rmr_wh_send_msg(3)