X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_bytes2xact.3.rst;h=12f29f20439598d64624a13ad9c492587e63a41d;hb=40e32867174c51c9b0ea50dfea19130c468cc200;hp=dd99f13956e46c45710ed32d59d99769ec66b716;hpb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_bytes2xact.3.rst b/docs/rmr_bytes2xact.3.rst index dd99f13..12f29f2 100644 --- a/docs/rmr_bytes2xact.3.rst +++ b/docs/rmr_bytes2xact.3.rst @@ -1,14 +1,14 @@ -.. 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_bytes2xact -============================================================================================ - - +.. 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_bytes2xact +============================================================================================ + + RMR LIBRARY FUNCTIONS @@ -19,63 +19,63 @@ RMR LIBRARY FUNCTIONS NAME ---- -rmr_bytes2xact +rmr_bytes2xact SYNOPSIS -------- - -:: - - #include - - int rmr_bytes2xact( rmr_mbuf_t* mbuf, unsigned char* src, int len ) - + +:: + + #include + + int rmr_bytes2xact( rmr_mbuf_t* mbuf, unsigned char* src, int len ) + DESCRIPTION ----------- -The ``rmr_bytes2xact`` function will copy up to *len* bytes -from *src* to the transaction ID (xaction) field in the -message. The field is a fixed length, gated by the constant -``RMR_MAX_XID`` and if len is larger than this value, only -``RMR_MAX_XID`` bytes will actually be copied. +The ``rmr_bytes2xact`` function will copy up to *len* bytes +from *src* to the transaction ID (xaction) field in the +message. The field is a fixed length, gated by the constant +``RMR_MAX_XID`` and if len is larger than this value, only +``RMR_MAX_XID`` 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. +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. - - +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 @@ -86,10 +86,10 @@ EXAMPLE SEE ALSO -------- -rmr_alloc_msg(3), rmr_bytes2meid(3), rmr_call(3), -rmr_free_msg(3), rmr_get_meid(3), rmr_get_rcvfd(3), -rmr_get_xact(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_wh_open(3), rmr_wh_send_msg(3) +rmr_alloc_msg(3), rmr_bytes2meid(3), rmr_call(3), +rmr_free_msg(3), rmr_get_meid(3), rmr_get_rcvfd(3), +rmr_get_xact(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_wh_open(3), rmr_wh_send_msg(3)