X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_get_src.3.rst;h=936e57095b124439b6c11957b1b079d0137b7e31;hb=ece5bbead6922f59982227c9941babdd6054cf17;hp=5202fc01a780c6ecb945972e804f7f71e024e21b;hpb=503fe41e88b66ff8986c991bfbd075331b0bd166;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_get_src.3.rst b/docs/rmr_get_src.3.rst index 5202fc0..936e570 100644 --- a/docs/rmr_get_src.3.rst +++ b/docs/rmr_get_src.3.rst @@ -1,81 +1,92 @@ - - -.. 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_get_src -============================================================================================ - -RMR Library Functions -============================================================================================ - - -NAME --------------------------------------------------------------------------------------------- - -rmr_get_src - -SYNOPSIS --------------------------------------------------------------------------------------------- - - -:: - - #include - unsigned char* rmr_get_src( rmr_mbuf_t* mbuf, unsigned char* dest ) - - - -DESCRIPTION --------------------------------------------------------------------------------------------- - -The rmr_get_src function will copy the *source* information -from the message to a buffer (dest) supplied by the user. In -an RMr message, the source is the sender's information that -is used for return to sender function calls, and is generally -the hostname and port in the form *name*. The source might be -an IP address port combination; the data is populated by the -sending process and the only requirement is that it be -capable of being used to start a TCP session with the sender. - -The maximum size allowed by RMr is 64 bytes (including the -nil string terminator), so the user must ensure that the -destination buffer given is at least 64 bytes. - -RETURN VALUE --------------------------------------------------------------------------------------------- - -On success, a pointer to the destination buffer is given as a -convenience to the user programme. On failure, a nil pointer -is returned and the value of errno is set. - -ERRORS --------------------------------------------------------------------------------------------- - -If an error occurs, the value of the global variable errno -will be set to one of the following with the indicated -meaning. - - - -EINVAL - - The message, or an internal portion of the message, was - corrupted or the pointer was invalid. - - -SEE ALSO --------------------------------------------------------------------------------------------- - -rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2meid(3), -rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3), -rmr_get_srcip(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_get_src +============================================================================================ + + + + +RMR LIBRARY FUNCTIONS +===================== + + + +NAME +---- + +rmr_get_src + + +SYNOPSIS +-------- + + +:: + + #include + + unsigned char* rmr_get_src( rmr_mbuf_t* mbuf, unsigned char* dest ) + + + +DESCRIPTION +----------- + +The ``rmr_get_src`` function will copy the *source* +information from the message to a buffer (dest) supplied by +the user. In an RMR message, the source is the sender's +information that is used for return to sender function calls, +and is generally the hostname and port in the form *name*. +The source might be an IP address port combination; the data +is populated by the sending process and the only requirement +is that it be capable of being used to start a TCP session +with the sender. + +The maximum size allowed by RMR is 64 bytes (including the +nil string terminator), so the user must ensure that the +destination buffer given is at least 64 bytes. + + +RETURN VALUE +------------ + +On success, a pointer to the destination buffer is given as a +convenience to the user programme. On failure, a nil pointer +is returned and the value of errno is set. + + +ERRORS +------ + +If an error occurs, the value of the global variable +``errno`` will be set to one of the following with the +indicated meaning. + + .. 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. + + + + +SEE ALSO +-------- + +rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2meid(3), +rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3), +rmr_get_srcip(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)