doc/src/man/rmr_payload_size.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_payload_size_man.xfm
  21         Abstract        The manual page for the rmr_payload_size function.
  22         Author          E. Scott Daniels
  23         Date            29 January 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_payload_size
  35
  36 &h2(SYNOPSIS )
  37 &indent
  38 &ex_start
  39 #include <rmr/rmr.h>
  40
  41 int rmr_payload_size( 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 available for the user application to consume in the message payload.
  48 This is different than the message length available as a field in the
  49 message buffer.
  50
  51 &h2(RETURN VALUE)
  52 The number of bytes available in the payload.
  53
  54 &h2(ERRORS)
  55 &beg_dlist(.75i : ^&bold_font )
  56 &di(INVAL) Parameter(s) passed to the function were not valid.
  57 &end_dlist
  58
  59
  60 &h2(SEE ALSO )
  61 rmr_alloc_msg(3),
  62 rmr_call(3),
  63 rmr_free_msg(3),
  64 rmr_init(3),
  65 rmr_send_msg(3),
  66 rmr_rcv_msg(3),
  67 rmr_rcv_specific(3),
  68 rmr_rts_msg(3),
  69 rmr_ready(3),
  70 rmr_fib(3),
  71 rmr_has_str(3),
  72 rmr_tokenise(3),
  73 rmr_mk_ring(3),
  74 rmr_ring_free(3)
  75
  76
  77 .qu
  78