docs/rmr_bytes2payload.3.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. CAUTION: this document is generated from source in doc/src/rtd.
   4 .. To make changes edit the source and recompile the document.
   5 .. Do NOT make changes directly to .rst or .md files.
   6
   7 ============================================================================================
   8 Man Page: rmr_bytes2payload
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_bytes2payload
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   void rmr_bytes2payload( rmr_mbuf_t* mbuf, unsigned char* src, int len )
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  40 This is a convenience function as some wrapper languages
  41 might not have the ability to directly copy into the payload
  42 buffer. The bytes from *src* for the length given are copied
  43 to the payload. It is the caller's responsibility to ensure
  44 that the payload is large enough. Upon successfully copy, the
  45 ``len`` field in the message buffer is updated to reflect the
  46 number of bytes copied.
  47
  48 There is little error checking, and no error reporting.
  49
  50
  51 RETURN VALUE
  52 ------------
  53
  54 None.
  55
  56
  57 EXAMPLE
  58 -------
  59
  60
  61
  62 SEE ALSO
  63 --------
  64
  65 rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2payload(3),
  66 rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3),
  67 rmr_get_meid(3), rmr_payload_size(3), rmr_send_msg(3),
  68 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
  69 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
  70 rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3),
  71 rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3)