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_payload_size
12 ============================================================================================
15 ============================================================================================
19 --------------------------------------------------------------------------------------------
24 --------------------------------------------------------------------------------------------
30 int rmr_payload_size( rmr_mbuf_t* msg );
35 --------------------------------------------------------------------------------------------
37 Given a message buffer, this function returns the amount of
38 space (bytes) available for the user application to consume
39 in the message payload. This is different than the message
40 length available as a field in the message buffer.
43 --------------------------------------------------------------------------------------------
45 The number of bytes available in the payload.
48 --------------------------------------------------------------------------------------------
54 Parameter(s) passed to the function were not valid.
58 --------------------------------------------------------------------------------------------
60 rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3), rmr_init(3),
61 rmr_send_msg(3), rmr_rcv_msg(3), rmr_rcv_specific(3),
62 rmr_rts_msg(3), rmr_ready(3), rmr_fib(3), rmr_has_str(3),
63 rmr_tokenise(3), rmr_mk_ring(3), rmr_ring_free(3)