3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
4 .. SPDX-License-Identifier: CC-BY-4.0
5 .. CAUTION: this document is generated from source in doc/src/rtd.
6 .. To make changes edit the source and recompile the document.
7 .. Do NOT make changes directly to .rst or .md files.
10 ============================================================================================
11 Man Page: rmr_get_srcip
12 ============================================================================================
15 ============================================================================================
19 --------------------------------------------------------------------------------------------
24 --------------------------------------------------------------------------------------------
30 unsigned char* rmr_get_srcip( rmr_mbuf_t* mbuf, unsigned char* dest )
35 --------------------------------------------------------------------------------------------
37 The rmr_get_srcip function will copy the *source IP address*
38 from the message to a buffer (dest) supplied by the user. In
39 an RMR message, the source IP address is the sender's
40 information that is used for return to sender function calls;
41 this function makes it available to the user application. The
42 address is maintained as IP:port where *IP* could be either
43 an IPv6 or IPv4 address depending on what was provided by the
46 The maximum size allowed by RMR is 64 bytes (including the
47 nil string terminator), so the user must ensure that the
48 destination buffer given is at least 64 bytes. The user
49 application should use the RMR constant RMR_MAX_SRC to ensure
50 that the buffer supplied is large enough, and to protect
51 against future RMR enhancements which might increase the
52 address buffer size requirement.
55 --------------------------------------------------------------------------------------------
57 On success, a pointer to the destination buffer is given as a
58 convenience to the user programme. On failure, a nil pointer
59 is returned and the value of errno is set.
62 --------------------------------------------------------------------------------------------
64 If an error occurs, the value of the global variable errno
65 will be set to one of the following with the indicated
72 The message, or an internal portion of the message, was
73 corrupted or the pointer was invalid.
77 --------------------------------------------------------------------------------------------
79 rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2meid(3),
80 rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3),
81 rmr_get_src(3), rmr_payload_size(3), rmr_send_msg(3),
82 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
83 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
84 rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3),
85 rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3)