doc/src/man/rmr_bytes2payload.3.xfm

   1 .if false
   2 ==================================================================================
   3         Copyright (c) 2019 Nokia
   4         Copyright (c) 2018-2019 AT&T Intellectual Property.
   5
   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
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  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 ==================================================================================
  18 .fi
  19
  20 .if false
  21         Mnemonic        rmr_bytes2payload.xfm
  22         Abstract        The manual page for the rmr_bytes2payload function.
  23         Author          E. Scott Daniels
  24         Date            8 March 2019
  25 .fi
  26
  27 .gv e LIB lib
  28 .im &{lib}/man/setup.im
  29
  30 &line_len(6i)
  31
  32 &h1(RMR Library Functions)
  33 &h2(NAME)
  34         rmr_bytes2payload
  35
  36 &h2(SYNOPSIS)
  37 &indent
  38 &ex_start
  39 #include <rmr/rmr.h>
  40
  41 void rmr_bytes2payload( rmr_mbuf_t* mbuf, unsigned char* src, int len )
  42 &ex_end
  43
  44 &uindent
  45
  46 &h2(DESCRIPTION)
  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.
  53 .sp
  54 There is little error checking, and no error reporting.
  55
  56
  57 &h2(RETURN VALUE)
  58 None.
  59
  60 &h2(EXAMPLE)
  61
  62
  63 &h2(SEE ALSO )
  64 rmr_alloc_msg(3),
  65 rmr_bytes2xact(3),
  66 rmr_bytes2payload(3),
  67 rmr_call(3),
  68 rmr_free_msg(3),
  69 rmr_get_rcvfd(3),
  70 rmr_get_meid(3),
  71 rmr_payload_size(3),
  72 rmr_send_msg(3),
  73 rmr_rcv_msg(3),
  74 rmr_rcv_specific(3),
  75 rmr_rts_msg(3),
  76 rmr_ready(3),
  77 rmr_fib(3),
  78 rmr_has_str(3),
  79 rmr_tokenise(3),
  80 rmr_mk_ring(3),
  81 rmr_ring_free(3),
  82 rmr_str2meid(3),
  83 rmr_str2xact(3),
  84 rmr_wh_open(3),
  85 rmr_wh_send_msg(3)
  86