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 ==================================================================================
21 Mnemonic rmr_bytes2payload.xfm
22 Abstract The manual page for the rmr_bytes2payload function.
23 Author E. Scott Daniels
28 .im &{lib}/man/setup.im
32 &h1(RMR Library Functions)
41 void rmr_bytes2payload( rmr_mbuf_t* mbuf, unsigned char* src, int len )
47 This is a convenience function as some wrapper languages might not have the ability to
48 directly copy into the payload buffer.
49 The bytes from &ital( src ) for the length given are copied to the payload.
50 It is the caller's responsibility to ensure that the payload is large enough.
51 Upon successfully copy, the &cw( len ) field in the message buffer is updated to
52 reflect the number of bytes copied.
54 There is little error checking, and no error reporting.