docs/rmr_get_xact.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_get_xact
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_get_xact
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   char* rmr_get_xact( rmr_mbuf_t* mbuf, unsigned char* dest )
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  40 The ``rmr_get_xact`` function will copy the transaction field
  41 from the message into the *dest* buffer provided by the user.
  42 The buffer referenced by *dest* is assumed to be at least
  43 ``RMR_MAX_XID`` bytes in length. If *dest* is NULL, then a
  44 buffer is allocated (the calling application is expected to
  45 free when the buffer is no longer needed).
  46
  47
  48 RETURN VALUE
  49 ------------
  50
  51 On success, a pointer to the extracted string is returned. If
  52 *dest* was supplied, then this is just a pointer to the
  53 caller's buffer. If *dest* was NULL, this is a pointer to the
  54 allocated buffer. If an error occurs, a nil pointer is
  55 returned and errno is set as described below.
  56
  57
  58 ERRORS
  59 ------
  60
  61 If an error occurs, the value of the global variable
  62 ``errno`` will be set to one of the following with the
  63 indicated meaning.
  64
  65     .. list-table::
  66       :widths: auto
  67       :header-rows: 0
  68       :class: borderless
  69
  70       * - **EINVAL**
  71         -
  72           The message, or an internal portion of the message, was
  73           corrupted or the pointer was invalid.
  74
  75       * - **ENOMEM**
  76         -
  77           A nil pointer was passed for *dest,* however it was not
  78           possible to allocate a buffer using malloc().
  79
  80
  81
  82
  83 SEE ALSO
  84 --------
  85
  86 rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2meid(3),
  87 rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3),
  88 rmr_get_meid(3), rmr_payload_size(3), rmr_send_msg(3),
  89 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
  90 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
  91 rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3),
  92 rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3)