doc/src/man/rmr_free_msg.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_free_msg_man.xfm
  22         Abstract        The manual page for the rmr_free_msg function.
  23         Author          E. Scott Daniels
  24         Date            28 January 2019
  25 .fi
  26
  27 .** if formatting with tfm, the roff.im will cause roff output to be generated
  28 .** if formatting with pfm, then pretty postscript will be generated
  29 .gv e LIB lib
  30 .if pfm
  31         .im &{lib}/generic_ps.im
  32 .ei
  33         .gv e OUTPUT_RST use_rst
  34         .if .ev &use_rst 1 =
  35                 .im &{lib}/rst.im
  36         .ei
  37                 .im &{lib}/roff.im
  38         .fi
  39 .fi
  40
  41 &line_len(6i)
  42
  43 &h1(RMR Library Functions)
  44 &h2(NAME)
  45         rmr_free_msg
  46
  47 &h2(SYNOPSIS )
  48 &indent
  49 &ex_start
  50 #include <rmr/rmr.h>
  51
  52 void rmr_free_msg( rmr_mbuf_t* mbuf );
  53 &ex_end
  54 &uindent
  55
  56 &h2(DESCRIPTION)
  57 The message buffer is returned to the pool, or the associated memory is
  58 released depending on the needs of the underlying messaging system.
  59 This allows the user application to release a buffer that is not going
  60 to be used.
  61 It is safe to pass a nil pointer to this function, and doing so does
  62 not result in a change to the value of &cw(errrno.)
  63 &space
  64
  65 After calling, the user application should &bold(not) use any of the
  66 pointers (transaction ID, or payload) which were available.
  67
  68
  69 &h2(SEE ALSO )
  70 rmr_alloc_msg(3),
  71 rmr_call(3),
  72 rmr_init(3),
  73 rmr_payload_size(3),
  74 rmr_send_msg(3),
  75 rmr_rcv_msg(3),
  76 rmr_rcv_specific(3),
  77 rmr_rts_msg(3),
  78 rmr_ready(3),
  79 rmr_fib(3),
  80 rmr_has_str(3),
  81 rmr_tokenise(3),
  82 rmr_mk_ring(3),
  83 rmr_ring_free(3)
  84
  85
  86 .qu
  87