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 .** if formatting with tfm, the roff.im will cause roff output to be generated
  27 .** if formatting with pfm, then pretty postscript will be generated
  28 .gv e LIB lib
  29 .if pfm
  30         .im &{lib}/generic_ps.im
  31 .ei
  32         .gv e OUTPUT_RST use_rst
  33         .if .ev &use_rst 1 =
  34                 .im &{lib}/rst.im
  35         .ei
  36                 .im &{lib}/roff.im
  37         .fi
  38 .fi
  39
  40
  41 &line_len(6i)
  42
  43 &h1(RMR Library Functions)
  44 &h2(NAME)
  45         rmr_get_trlen
  46
  47 &h2(SYNOPSIS )
  48 &indent
  49 &ex_start
  50 #include <rmr/rmr.h>
  51
  52 int rmr_get_trlen( rmr_mbuf_t* msg );
  53 &ex_end
  54 &uindent
  55
  56 &h2(DESCRIPTION)
  57 Given a message buffer, this function returns the amount of space (bytes)
  58 that have been allocated for trace data.
  59 If no trace data has been allocated, then 0 is returned.
  60
  61 &h2(RETURN VALUE)
  62 The number of bytes allocated for trace information in the given message.
  63
  64 &h2(ERRORS)
  65 &beg_dlist(.75i : ^&bold_font )
  66 &di(INVAL) Parameter(s) passed to the function were not valid.
  67 &end_dlist
  68
  69
  70 &h2(SEE ALSO )
  71 rmr_alloc_msg(3),
  72 rmr_call(3),
  73 rmr_free_msg(3),
  74 rmr_get_trace(3),
  75 rmr_init(3),
  76 rmr_init_trace(3),
  77 rmr_send_msg(3),
  78 rmr_rcv_msg(3),
  79 rmr_rcv_specific(3),
  80 rmr_rts_msg(3),
  81 rmr_ready(3),
  82 rmr_fib(3),
  83 rmr_has_str(3),
  84 rmr_tokenise(3),
  85 rmr_mk_ring(3),
  86 rmr_ring_free(3),
  87 rmr_set_trace(3),
  88 rmr_tralloc_msg(3)
  89
  90
  91 .qu
  92