docs/rmr_trace_ref.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_trace_ref
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_trace_ref
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31  #include <rmr/rmr.h>
  32
  33  int rmr_trace_ref( rmr_mbuf_t* mbuf, int* sizeptr )
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  40 The ``rmr_trace_ref`` function returns a pointer to the trace
  41 area in the message, and optionally populates the user
  42 programme supplied size integer with the trace area size, if
  43 *sizeptr* is not nil.
  44
  45
  46 RETURN VALUE
  47 ------------
  48
  49 On success, a void pointer to the trace area of the message
  50 is returned. A nil pointer is returned if the message has no
  51 trace data area allocated, or if the message itself is
  52 invalid.
  53
  54
  55 SEE ALSO
  56 --------
  57
  58 rmr_alloc_msg(3), rmr_tralloc_msg(3), rmr_bytes2xact(3),
  59 rmr_bytes2meid(3), rmr_call(3), rmr_free_msg(3),
  60 rmr_get_rcvfd(3), rmr_get_trlen(3), rmr_init(3),
  61 rmr_init_trace(3), rmr_payload_size(3), rmr_send_msg(3),
  62 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
  63 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
  64 rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3),
  65 rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3),
  66 rmr_set_trace(3)