X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_get_srcip.3.xfm;h=1f589bed3588f4eea40c69fc5b41391968f2aae7;hb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;hp=9e3103b6948b598a8e9ee1f4bae07e59a38e0ba6;hpb=b7a4b52f73d51db6077d2c0b56be262c36f472f7;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_get_srcip.3.xfm b/doc/src/man/rmr_get_srcip.3.xfm index 9e3103b..1f589be 100644 --- a/doc/src/man/rmr_get_srcip.3.xfm +++ b/doc/src/man/rmr_get_srcip.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,20 +18,20 @@ .fi .if false - Mnemonic rmr_get_srcip.xfm - Abstract The manual page for the rmr_get_srcip function. - Author E. Scott Daniels - Date 11 June 2019 + Mnemonic rmr_get_srcip.xfm + Abstract The manual page for the rmr_get_srcip function. + Author E. Scott Daniels + Date 11 June 2019 .fi .gv e LIB lib -.im &{lib}/man/setup.im +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_get_srcip + rmr_get_srcip &h2(SYNOPSIS) &indent @@ -46,16 +46,16 @@ unsigned char* rmr_get_srcip( rmr_mbuf_t* mbuf, unsigned char* dest ) &h2(DESCRIPTION) The &cw(rmr_get_srcip) function will copy the &ital(source IP address) from the message to a buffer (dest) supplied by the user. -In an RMr message, the source IP address is the sender's information that is used for return to sender -function calls; this function makes it available to the user application. +In an RMR message, the source IP address is the sender's information that is used for return to sender +function calls; this function makes it available to the user application. The address is maintained as IP:port where &ital(IP) could be either an IPv6 or IPv4 address depending on what was provided by the sending application. .sp -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. The user application should use -the RMr constant RMR_MAX_SRC to ensure that the buffer supplied is large enough, and to protect -against future RMr enhancements which might increase the address buffer size requirement. +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. The user application should use +the RMR constant RMR_MAX_SRC to ensure that the buffer supplied is large enough, and to protect +against future RMR enhancements which might increase the address buffer size requirement. &h2(RETURN VALUE) On success, a pointer to the destination buffer is given as a convenience to the user programme. @@ -66,8 +66,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