| E. Scott Daniels | 117030c | 2020-04-10 17:17:02 -0400 | [diff] [blame] | 1 | |
| 2 | |
| 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. |
| 8 | |
| 9 | |
| 10 | ============================================================================================ |
| 11 | Man Page: rmr_bytes2payload |
| 12 | ============================================================================================ |
| 13 | |
| 14 | RMR Library Functions |
| 15 | ============================================================================================ |
| 16 | |
| 17 | |
| 18 | NAME |
| 19 | -------------------------------------------------------------------------------------------- |
| 20 | |
| 21 | rmr_bytes2payload |
| 22 | |
| 23 | SYNOPSIS |
| 24 | -------------------------------------------------------------------------------------------- |
| 25 | |
| 26 | |
| 27 | :: |
| 28 | |
| 29 | #include <rmr/rmr.h> |
| 30 | void rmr_bytes2payload( rmr_mbuf_t* mbuf, unsigned char* src, int len ) |
| 31 | |
| 32 | |
| 33 | |
| 34 | DESCRIPTION |
| 35 | -------------------------------------------------------------------------------------------- |
| 36 | |
| 37 | This is a convenience function as some wrapper languages |
| 38 | might not have the ability to directly copy into the payload |
| 39 | buffer. The bytes from *src* for the length given are copied |
| 40 | to the payload. It is the caller's responsibility to ensure |
| 41 | that the payload is large enough. Upon successfully copy, the |
| 42 | len field in the message buffer is updated to reflect the |
| 43 | number of bytes copied. |
| 44 | |
| 45 | There is little error checking, and no error reporting. |
| 46 | |
| 47 | RETURN VALUE |
| 48 | -------------------------------------------------------------------------------------------- |
| 49 | |
| 50 | None. |
| 51 | |
| 52 | EXAMPLE |
| 53 | -------------------------------------------------------------------------------------------- |
| 54 | |
| 55 | |
| 56 | SEE ALSO |
| 57 | -------------------------------------------------------------------------------------------- |
| 58 | |
| 59 | rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2payload(3), |
| 60 | rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3), |
| 61 | rmr_get_meid(3), rmr_payload_size(3), rmr_send_msg(3), |
| 62 | rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3), |
| 63 | rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), |
| 64 | rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3), |
| 65 | rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3) |