docs/rmr_bytes2meid.3.rst

   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_bytes2meid
  12 ============================================================================================
  13
  14 RMR Library Functions
  15 ============================================================================================
  16
  17
  18 NAME
  19 --------------------------------------------------------------------------------------------
  20
  21 rmr_bytes2meid
  22
  23 SYNOPSIS
  24 --------------------------------------------------------------------------------------------
  25
  26
  27 ::
  28
  29  #include <rmr/rmr.h>
  30  int rmr_bytes2meid( rmr_mbuf_t* mbuf, unsigned char* src, int len )
  31
  32
  33
  34 DESCRIPTION
  35 --------------------------------------------------------------------------------------------
  36
  37 The rmr_bytes2meid function will copy up to *len* butes from
  38 *src* to the managed entity ID (meid) field in the message.
  39 The field is a fixed length, gated by the constant
  40 RMR_MAX_MEID and if len is larger than this value, only
  41 RMR_MAX_MEID bytes will actually be copied.
  42
  43 RETURN VALUE
  44 --------------------------------------------------------------------------------------------
  45
  46 On success, the actual number of bytes copied is returned, or
  47 -1 to indicate a hard error. If the length is less than 0, or
  48 not the same as length passed in, errno is set to one of the
  49 errors described in the *Errors* section.
  50
  51 ERRORS
  52 --------------------------------------------------------------------------------------------
  53
  54 If the returned length does not match the length passed in,
  55 errno will be set to one of the following constants with the
  56 meaning listed below.
  57
  58
  59
  60 EINVAL
  61
  62   The message, or an internal portion of the message, was
  63   corrupted or the pointer was invalid.
  64
  65
  66 EOVERFLOW
  67
  68   The length passed in was larger than the maximum length of
  69   the field; only a portion of the source bytes were copied.
  70
  71
  72 EXAMPLE
  73 --------------------------------------------------------------------------------------------
  74
  75
  76 SEE ALSO
  77 --------------------------------------------------------------------------------------------
  78
  79 rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_call(3),
  80 rmr_free_msg(3), rmr_get_rcvfd(3), rmr_get_meid(3),
  81 rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3),
  82 rmr_rcv_specific(3), rmr_rts_msg(3), rmr_ready(3),
  83 rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3),
  84 rmr_ring_free(3), rmr_str2meid(3), rmr_str2xact(3),
  85 rmr_wh_open(3), rmr_wh_send_msg(3)