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