X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Frmr_payload_size.3.rst;fp=docs%2Frmr_payload_size.3.rst;h=58b674f59296ef6aeb491a829d95ea2fcd1b6ccb;hb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;hp=a8fd98a5576de6972cd0222f87f06f6e7019692e;hpb=2b3c393e660c5e1037191f43cc70537da8316b89;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_payload_size.3.rst b/docs/rmr_payload_size.3.rst index a8fd98a..58b674f 100644 --- a/docs/rmr_payload_size.3.rst +++ b/docs/rmr_payload_size.3.rst @@ -1,62 +1,73 @@ - - .. 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_payload_size ============================================================================================ -RMR Library Functions -============================================================================================ - - -NAME --------------------------------------------------------------------------------------------- + + +RMR LIBRARY FUNCTIONS +===================== + + + +NAME +---- + rmr_payload_size - -SYNOPSIS --------------------------------------------------------------------------------------------- - + + +SYNOPSIS +-------- + :: - + #include + int rmr_payload_size( rmr_mbuf_t* msg ); - - -DESCRIPTION --------------------------------------------------------------------------------------------- - + + +DESCRIPTION +----------- + Given a message buffer, this function returns the amount of space (bytes) available for the user application to consume in the message payload. This is different than the message length available as a field in the message buffer. - -RETURN VALUE --------------------------------------------------------------------------------------------- - + + +RETURN VALUE +------------ + The number of bytes available in the payload. - -ERRORS --------------------------------------------------------------------------------------------- - - - -INVAL - - Parameter(s) passed to the function were not valid. - - -SEE ALSO --------------------------------------------------------------------------------------------- - + + +ERRORS +------ + + + .. list-table:: + :widths: auto + :header-rows: 0 + :class: borderless + + * - **INVAL** + - + Parameter(s) passed to the function were not valid. + + + + +SEE ALSO +-------- + rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3), rmr_init(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),