docs/rmr_get_trace.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_get_trace
  12 ============================================================================================
  13
  14 RMR Library Functions
  15 ============================================================================================
  16
  17
  18 NAME
  19 --------------------------------------------------------------------------------------------
  20
  21 rmr_get_trace
  22
  23 SYNOPSIS
  24 --------------------------------------------------------------------------------------------
  25
  26
  27 ::
  28
  29  #include <rmr/rmr.h>
  30  int rmr_get_trace( rmr_mbuf_t* mbuf, unsigned char* dest, int size )
  31
  32
  33
  34 DESCRIPTION
  35 --------------------------------------------------------------------------------------------
  36
  37 The rmr_get_trace function will copy the trace information
  38 from the message into the user's allocated memory referenced
  39 by dest. The size parameter is assumed to be the maximum
  40 number of bytes which can be copied (size of the destination
  41 buffer).
  42
  43 RETURN VALUE
  44 --------------------------------------------------------------------------------------------
  45
  46 On success, the number of bytes actually copied is returned.
  47 If the return value is 0, no bytes copied, then the reason
  48 could be that the message pointer was nil, or the size
  49 parameter was <= 0.
  50
  51 SEE ALSO
  52 --------------------------------------------------------------------------------------------
  53
  54 rmr_alloc_msg(3), rmr_tralloc_msg(3), rmr_bytes2xact(3),
  55 rmr_bytes2meid(3), rmr_call(3), rmr_free_msg(3),
  56 rmr_get_rcvfd(3), rmr_get_trlen(3), rmr_init(3),
  57 rmr_init_trace(3), rmr_payload_size(3), rmr_send_msg(3),
  58 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
  59 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
  60 rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3),
  61 rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3),
  62 rmr_set_trace(3), rmr_trace_ref(3)