Man Page: rmr_get_srcip¶

RMR LIBRARY FUNCTIONS¶

NAME¶

rmr_get_srcip

SYNOPSIS¶

#include <rmr/rmr.h>

unsigned char* rmr_get_srcip( rmr_mbuf_t* mbuf, unsigned char* dest )

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 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 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.

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.