2 ==================================================================================
3 Copyright (c) 2019 Nokia
4 Copyright (c) 2018-2019 AT&T Intellectual Property.
6 Licensed under the Apache License, Version 2.0 (the "License");
7 you may not use this file except in compliance with the License.
8 You may obtain a copy of the License at
10 http://www.apache.org/licenses/LICENSE-2.0
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS,
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 See the License for the specific language governing permissions and
16 limitations under the License.
17 ==================================================================================
20 Mnemonic rmr_payload_size_man.xfm
21 Abstract The manual page for the rmr_payload_size function.
22 Author E. Scott Daniels
27 .im &{lib}/man/setup.im
32 &h1(RMR Library Functions)
41 int rmr_payload_size( rmr_mbuf_t* msg );
46 Given a message buffer, this function returns the amount of space (bytes)
47 available for the user application to consume in the message payload.
48 This is different than the message length available as a field in the
52 The number of bytes available in the payload.
55 &beg_dlist(.75i : ^&bold_font )
56 &di(INVAL) Parameter(s) passed to the function were not valid.