doc/src/man/rmr_init_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_init_trace_man.xfm
  22         Abstract        The manual page for the rmr_init_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_init_trace
  35
  36 &h2(SYNOPSIS)
  37 &indent
  38 &ex_start
  39 #include <rmr/rmr.h>
  40
  41 void* rmr_init_trace( void* ctx )
  42 &ex_end
  43
  44 &uindent
  45
  46 &h2(DESCRIPTION)
  47 The &cw(rmr_init_trace) function establishes the default trace space placed in each
  48 message buffer allocated with &cw(rmr_alloc_msg().)
  49 If this function is never called, then no trace space is allocated by default into
  50 any message buffer.
  51
  52 .sp
  53 Trace space allows the user application to pass some trace token, or other data
  54 with the message, but outside of the payload.
  55 Trace data may be added to any message with &cw(rmr_set_trace(),) and may be extracted
  56 from a message with &cw(rmr_get_trace().)
  57 The number of bytes that a message contains for/with trace data can be determined by
  58 invoking &cw(rmr_get_trlen().)
  59
  60 .sp
  61 This function may be safely called at any time during the life of the user programme
  62 to (re)set the default trace space reserved.
  63 If the user programme needs to allocate a message with trace space of a different
  64 size than is allocated by default, without fear of extra overhead of reallocating
  65 a message later, the &cw(rmr_tralloc_msg()) function can be used.
  66
  67 &h2(RETURN VALUE)
  68 A value of 1 is returned on success, and 0 on failure.  A failure indicates that the
  69 RMr context (a void pointer passed to this function was not valid.
  70
  71 &h2(SEE ALSO )
  72 .ju off
  73 rmr_alloc_msg(3),
  74 rmr_tr_alloc_msg(3),
  75 rmr_call(3),
  76 rmr_free_msg(3),
  77 rmr_get_rcvfd(3),
  78 rmr_get_trace(3),
  79 rmr_get_trlen(3),
  80 rmr_payload_size(3),
  81 rmr_send_msg(3),
  82 rmr_rcv_msg(3),
  83 rmr_rcv_specific(3),
  84 rmr_rts_msg(3),
  85 rmr_ready(3),
  86 rmr_fib(3),
  87 rmr_has_str(3),
  88 rmr_tokenise(3),
  89 rmr_mk_ring(3),
  90 rmr_ring_free(3),
  91 rmr_set_trace(3)
  92 .ju on
  93