doc/src/man/rmr_get_trlen.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 .if false
  20     Mnemonic    rmr_get_trlen
  21     Abstract    The manual page for the get trace len function.
  22     Author      E. Scott Daniels
  23     Date        19 April 2019
  24 .fi
  25
  26 .gv e LIB lib
  27 .im &{lib}/man/setup.im
  28
  29
  30 &line_len(6i)
  31
  32 &h1(RMR Library Functions)
  33 &h2(NAME)
  34     rmr_get_trlen
  35
  36 &h2(SYNOPSIS )
  37 &indent
  38 &ex_start
  39 #include <rmr/rmr.h>
  40
  41 int rmr_get_trlen( rmr_mbuf_t* msg );
  42 &ex_end
  43 &uindent
  44
  45 &h2(DESCRIPTION)
  46 Given a message buffer, this function returns the amount of space (bytes)
  47 that have been allocated for trace data.
  48 If no trace data has been allocated, then 0 is returned.
  49
  50 &h2(RETURN VALUE)
  51 The number of bytes allocated for trace information in the given message.
  52
  53 &h2(ERRORS)
  54 &beg_dlist(.75i : ^&bold_font )
  55 &di(INVAL) Parameter(s) passed to the function were not valid.
  56 &end_dlist
  57
  58
  59 &h2(SEE ALSO )
  60 .ju off
  61 rmr_alloc_msg(3),
  62 rmr_call(3),
  63 rmr_free_msg(3),
  64 rmr_get_trace(3),
  65 rmr_init(3),
  66 rmr_init_trace(3),
  67 rmr_send_msg(3),
  68 rmr_rcv_msg(3),
  69 rmr_rcv_specific(3),
  70 rmr_rts_msg(3),
  71 rmr_ready(3),
  72 rmr_fib(3),
  73 rmr_has_str(3),
  74 rmr_tokenise(3),
  75 rmr_mk_ring(3),
  76 rmr_ring_free(3),
  77 rmr_set_trace(3),
  78 rmr_tralloc_msg(3)
  79 .ju on
  80