docs/rmr_str2xact.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_str2xact
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_str2xact
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   int rmr_str2xact( rmr_mbuf_t* mbuf, unsigned char* src, int len )
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  40 The ``rmr_str2xact`` function will copy the string pointed to
  41 by src to the transaction ID (xaction) field in the given
  42 message. The field is a fixed length, gated by the constant
  43 ``RMR_MAX_XID`` and if string length is larger than this
  44 value, then **nothing** will be copied. (Note, this differs
  45 slightly from the behaviour of the ``lrmr_bytes2xact()``
  46 function.)
  47
  48
  49 RETURN VALUE
  50 ------------
  51
  52 On success, the value RMR_OK is returned. If the string
  53 cannot be copied to the message, the return value will be one
  54 of the errors listed below.
  55
  56
  57 ERRORS
  58 ------
  59
  60 If the return value is not RMR_OK, then it will be set to one
  61 of the values below.
  62
  63     .. list-table::
  64       :widths: auto
  65       :header-rows: 0
  66       :class: borderless
  67
  68       * - **RMR_ERR_BADARG**
  69         -
  70           The message, or an internal portion of the message, was
  71           corrupted or the pointer was invalid.
  72
  73       * - **RMR_ERR_OVERFLOW**
  74         -
  75           The length passed in was larger than the maximum length of
  76           the field; only a portion of the source bytes were copied.
  77
  78
  79
  80
  81 EXAMPLE
  82 -------
  83
  84
  85
  86 SEE ALSO
  87 --------
  88
  89 rmr_alloc_msg(3), rmr_bytes2meid(3), rmr_bytes2xact(3),
  90 rmr_call(3), rmr_free_msg(3), rmr_get_meid(3),
  91 rmr_get_rcvfd(3), rmr_get_xact(3), rmr_payload_size(3),
  92 rmr_send_msg(3), rmr_rcv_msg(3), rmr_rcv_specific(3),
  93 rmr_rts_msg(3), rmr_ready(3), rmr_fib(3), rmr_has_str(3),
  94 rmr_tokenise(3), rmr_mk_ring(3), rmr_ring_free(3),
  95 rmr_str2meid(3), rmr_wh_open(3), rmr_wh_send_msg(3)