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_xact
12 ============================================================================================
15 ============================================================================================
19 --------------------------------------------------------------------------------------------
24 --------------------------------------------------------------------------------------------
30 char* rmr_get_xact( rmr_mbuf_t* mbuf, unsigned char* dest )
35 --------------------------------------------------------------------------------------------
37 The rmr_get_xact function will copy the transaction field
38 from the message into the *dest* buffer provided by the user.
39 The buffer referenced by *dest* is assumed to be at least
40 RMR_MAX_XID bytes in length. If *dest* is NULL, then a buffer
41 is allocated (the calling application is expected to free
42 when the buffer is no longer needed).
45 --------------------------------------------------------------------------------------------
47 On success, a pointer to the extracted string is returned. If
48 *dest* was supplied, then this is just a pointer to the
49 caller's buffer. If *dest* was NULL, this is a pointer to the
50 allocated buffer. If an error occurs, a nil pointer is
51 returned and errno is set as described below.
54 --------------------------------------------------------------------------------------------
56 If an error occurs, the value of the global variable errno
57 will be set to one of the following with the indicated
64 The message, or an internal portion of the message, was
65 corrupted or the pointer was invalid.
70 A nil pointer was passed for *dest,* however it was not
71 possible to allocate a buffer using malloc().
75 --------------------------------------------------------------------------------------------
77 rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2meid(3),
78 rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3),
79 rmr_get_meid(3), rmr_payload_size(3), rmr_send_msg(3),
80 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
81 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
82 rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3),
83 rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3)