docs/rmr_get_trlen.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_trlen
  12 ============================================================================================
  13
  14 RMR Library Functions
  15 ============================================================================================
  16
  17
  18 NAME
  19 --------------------------------------------------------------------------------------------
  20
  21 rmr_get_trlen
  22
  23 SYNOPSIS
  24 --------------------------------------------------------------------------------------------
  25
  26
  27 ::
  28
  29  #include <rmr/rmr.h>
  30  int rmr_get_trlen( rmr_mbuf_t* msg );
  31
  32
  33
  34 DESCRIPTION
  35 --------------------------------------------------------------------------------------------
  36
  37 Given a message buffer, this function returns the amount of
  38 space (bytes) that have been allocated for trace data. If no
  39 trace data has been allocated, then 0 is returned.
  40
  41 RETURN VALUE
  42 --------------------------------------------------------------------------------------------
  43
  44 The number of bytes allocated for trace information in the
  45 given message.
  46
  47 ERRORS
  48 --------------------------------------------------------------------------------------------
  49
  50
  51
  52 INVAL
  53
  54   Parameter(s) passed to the function were not valid.
  55
  56
  57 SEE ALSO
  58 --------------------------------------------------------------------------------------------
  59
  60 rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3),
  61 rmr_get_trace(3), rmr_init(3), rmr_init_trace(3),
  62 rmr_send_msg(3), rmr_rcv_msg(3), rmr_rcv_specific(3),
  63 rmr_rts_msg(3), rmr_ready(3), rmr_fib(3), rmr_has_str(3),
  64 rmr_tokenise(3), rmr_mk_ring(3), rmr_ring_free(3),
  65 rmr_set_trace(3), rmr_tralloc_msg(3)