X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_get_srcip.3.rst;h=f4bb20aedf97da8b97f88f9d3b6dd97cadfd4f0f;hb=d762b36427051dc6d1a7e64b44df4334f1ad9dbd;hp=a8cf43463e4ef6a08ff19b15d6a90ee65dfd9695;hpb=503fe41e88b66ff8986c991bfbd075331b0bd166;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_get_srcip.3.rst b/docs/rmr_get_srcip.3.rst index a8cf434..f4bb20a 100644 --- a/docs/rmr_get_srcip.3.rst +++ b/docs/rmr_get_srcip.3.rst @@ -36,19 +36,19 @@ DESCRIPTION The rmr_get_srcip function will copy the *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 +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 *IP* could be either an IPv6 or IPv4 address depending on what was provided by the sending application. -The maximum size allowed by RMr is 64 bytes (including the +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 +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 +against future RMR enhancements which might increase the address buffer size requirement. RETURN VALUE