X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=doc%2Fsrc%2Fman%2Frmr_get_src.3.xfm;h=f3a79fb6845b219d1450f563ce2cc036abd4dc38;hb=fa454008020483ac35e1d20300cddfe877d8dd6d;hp=31d82ff8abc188da99b97f8955833017582edcf2;hpb=5157a97ada5447efcee4da6192798a3b6799884c;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 31d82ff..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. @@ -46,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) @@ -65,8 +65,7 @@ If an error occurs, the value of the global variable &cw(errno) will be set to o 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. +&ditem(EINVAL) The message, or an internal portion of the message, was corrupted or the pointer was invalid. &end_dlist