doc/src/man/rmr_set_trace.3.xfm

   1 .if false
   2 ==================================================================================
   3         Copyright (c) 2019 Nokia
   4         Copyright (c) 2018-2019 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 .fi
  19
  20 .if false
  21         Mnemonic        rmr_set_trace.xfm
  22         Abstract        The manual page for the rmr_set_trace function.
  23         Author          E. Scott Daniels
  24         Date            19 April 2019
  25 .fi
  26
  27 .gv e LIB lib
  28 .im &{lib}/man/setup.im
  29
  30 &line_len(6i)
  31
  32 &h1(RMR Library Functions)
  33 &h2(NAME)
  34         rmr_set_trace
  35
  36 &h2(SYNOPSIS)
  37 &indent
  38 &ex_start
  39 #include <rmr/rmr.h>
  40
  41 int rmr_bytes2payload( rmr_mbuf_t* mbuf, unsigned char* data, int len )
  42 &ex_end
  43
  44 &uindent
  45
  46 &h2(DESCRIPTION)
  47 The &cw(rmr_set_trace) function will copy &cw(len) bytes from &cw(data) into the trace portion of
  48 &cw(mbuf.)
  49 If the trace area of &cw(mbuf) is not the correct size, the message buffer will be reallocated
  50 to ensure that enough space is available for the trace data.
  51
  52
  53 &h2(RETURN VALUE)
  54 The &cw(rmr_set_trace) function returns the number of bytes successfully copied to the message.
  55 If 0 is returned either the message pointer was nil, or the size in the parameters was <= 0.
  56
  57
  58
  59 &h2(SEE ALSO )
  60 rmr_alloc_msg(3),
  61 rmr_tralloc_msg(3),
  62 rmr_bytes2xact(3),
  63 rmr_bytes2payload(3),
  64 rmr_call(3),
  65 rmr_free_msg(3),
  66 rmr_get_rcvfd(3),
  67 rmr_get_meid(3),
  68 rmr_get_trace(3),
  69 rmr_get_trlen(3),
  70 rmr_init(3),
  71 rmr_init_trace(3),
  72 rmr_payload_size(3),
  73 rmr_send_msg(3),
  74 rmr_rcv_msg(3),
  75 rmr_rcv_specific(3),
  76 rmr_rts_msg(3),
  77 rmr_ready(3),
  78 rmr_fib(3),
  79 rmr_has_str(3),
  80 rmr_tokenise(3),
  81 rmr_mk_ring(3),
  82 rmr_ring_free(3),
  83 rmr_str2meid(3),
  84 rmr_str2xact(3),
  85 rmr_wh_open(3),
  86 rmr_wh_send_msg(3)
  87
  88
  89
  90 .qu
  91