X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_get_src.3.xfm;h=f3a79fb6845b219d1450f563ce2cc036abd4dc38;hb=HEAD;hp=5ea92f33870686ea4df4ea404080fe54cf93f79c;hpb=c1aee2b63a523a461e96a8d358c73dd8a9e9e6a2;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_get_src.3.xfm b/doc/src/man/rmr_get_src.3.xfm index 5ea92f3..f3a79fb 100644 --- a/doc/src/man/rmr_get_src.3.xfm +++ b/doc/src/man/rmr_get_src.3.xfm @@ -1,7 +1,7 @@ .if false ================================================================================== - Copyright (c) 2019 Nokia - Copyright (c) 2018-2019 AT&T Intellectual Property. + Copyright (c) 2019-2020 Nokia + Copyright (c) 2018-2020 AT&T Intellectual Property. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -18,31 +18,20 @@ .fi .if false - Mnemonic rmr_get_src.xfm - Abstract The manual page for the rmr_get_src function. - Author E. Scott Daniels - Date 8 March 2019 + Mnemonic rmr_get_src.xfm + Abstract The manual page for the rmr_get_src function. + Author E. Scott Daniels + Date 8 March 2019 .fi -.** if formatting with tfm, the roff.im will cause roff output to be generated -.** if formatting with pfm, then pretty postscript will be generated .gv e LIB lib -.if pfm - .im &{lib}/generic_ps.im -.ei - .gv e OUTPUT_RST use_rst - .if .ev &use_rst 1 = - .im &{lib}/rst.im - .ei - .im &{lib}/roff.im - .fi -.fi +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_get_src + rmr_get_src &h2(SYNOPSIS) &indent @@ -57,14 +46,14 @@ unsigned char* rmr_get_src( rmr_mbuf_t* mbuf, unsigned char* dest ) &h2(DESCRIPTION) The &cw(rmr_get_src) function will copy the &ital(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 +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 &ital(name:port). 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. .sp -The maximum size allowed by RMr is 64 bytes (including the nil string terminator), so the user +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. &h2(RETURN VALUE) @@ -72,13 +61,12 @@ On success, a pointer to the destination buffer is given as a convenience to the On failure, a nil pointer is returned and the value of errno is set. &h2(ERRORS) -If an error occurs, the value of the global variable &cw( errno ) will be set to one of +If an error occurs, the value of the global variable &cw(errno) will be set to one of the following with the indicated meaning. &beg_dlist(.75i : ^&bold_font ) -&half_space -&di(EINVAL) The message, or an internal portion of the message, was corrupted or the pointer was invalid. -&end_dilist +&ditem(EINVAL) The message, or an internal portion of the message, was corrupted or the pointer was invalid. +&end_dlist @@ -90,6 +78,7 @@ 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), @@ -107,6 +96,3 @@ rmr_wh_open(3), rmr_wh_send_msg(3) .ju on - -.qu -