docs/rmr_set_trace.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_set_trace
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_set_trace
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   int rmr_set_trace( rmr_mbuf_t* mbuf, unsigned char* data, int len )
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  40 The ``rmr_set_trace`` function will copy ``len`` bytes from
  41 ``data`` into the trace portion of ``mbuf.`` If the trace
  42 area of ``mbuf`` is not the correct size, the message buffer
  43 will be reallocated to ensure that enough space is available
  44 for the trace data.
  45
  46
  47 RETURN VALUE
  48 ------------
  49
  50 The ``rmr_set_trace`` function returns the number of bytes
  51 successfully copied to the message. If 0 is returned either
  52 the message pointer was nil, or the size in the parameters
  53 was <= 0.
  54
  55
  56 SEE ALSO
  57 --------
  58
  59 rmr_alloc_msg(3), rmr_tralloc_msg(3), rmr_bytes2xact(3),
  60 rmr_bytes2payload(3), rmr_call(3), rmr_free_msg(3),
  61 rmr_get_rcvfd(3), rmr_get_meid(3), rmr_get_trace(3),
  62 rmr_get_trlen(3), rmr_init(3), rmr_init_trace(3),
  63 rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3),
  64 rmr_rcv_specific(3), rmr_rts_msg(3), rmr_ready(3),
  65 rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3),
  66 rmr_ring_free(3), rmr_str2meid(3), rmr_str2xact(3),
  67 rmr_wh_open(3), rmr_wh_send_msg(3)