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_bytes2xact
12 ============================================================================================
15 ============================================================================================
19 --------------------------------------------------------------------------------------------
24 --------------------------------------------------------------------------------------------
30 int rmr_bytes2xact( rmr_mbuf_t* mbuf, unsigned char* src, int len )
35 --------------------------------------------------------------------------------------------
37 The rmr_bytes2xact function will copy up to *len* bytes from
38 *src* to the transaction ID (xaction) field in the message.
39 The field is a fixed length, gated by the constant
40 RMR_MAX_XID and if len is larger than this value, only
41 RMR_MAX_XID bytes will actually be copied.
45 --------------------------------------------------------------------------------------------
47 On success, the actual number of bytes copied is returned,
48 or -1 to indicate a hard error. If the length is less than
49 0, or not the same as length passed in, errno is set to
50 one of the errors described in the *Errors* section.
53 --------------------------------------------------------------------------------------------
55 If the returned length does not match the length passed
56 in, errno will be set to one of the following constants
57 with the meaning listed below.
62 The message, or an internal portion of the message, was
63 corrupted or the pointer was invalid.
68 The length passed in was larger than the maximum length of
69 the field; only a portion of the source bytes were copied.
73 --------------------------------------------------------------------------------------------
77 --------------------------------------------------------------------------------------------
79 rmr_alloc_msg(3), rmr_bytes2meid(3), rmr_call(3),
80 rmr_free_msg(3), rmr_get_meid(3), rmr_get_rcvfd(3),
81 rmr_get_xact(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_wh_open(3), rmr_wh_send_msg(3)