docs/rmr_free_msg.3.rst

   1
   2
   3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   4 .. SPDX-License-Identifier: CC-BY-4.0
   5 .. CAUTION: this document is generated from source in doc/src/rtd.
   6 .. To make changes edit the source and recompile the document.
   7 .. Do NOT make changes directly to .rst or .md files.
   8
   9
  10 ============================================================================================
  11 Man Page: rmr_free_msg
  12 ============================================================================================
  13
  14 RMR Library Functions
  15 ============================================================================================
  16
  17
  18 NAME
  19 --------------------------------------------------------------------------------------------
  20
  21 rmr_free_msg
  22
  23 SYNOPSIS
  24 --------------------------------------------------------------------------------------------
  25
  26
  27 ::
  28
  29  #include <rmr/rmr.h>
  30  void rmr_free_msg( rmr_mbuf_t* mbuf );
  31
  32
  33
  34 DESCRIPTION
  35 --------------------------------------------------------------------------------------------
  36
  37 The message buffer is returned to the pool, or the associated
  38 memory is released depending on the needs of the underlying
  39 messaging system. This allows the user application to release
  40 a buffer that is not going to be used. It is safe to pass a
  41 nil pointer to this function, and doing so does not result in
  42 a change to the value of errrno.
  43
  44 After calling, the user application should **not** use any of
  45 the pointers (transaction ID, or payload) which were
  46 available.
  47
  48 SEE ALSO
  49 --------------------------------------------------------------------------------------------
  50
  51 rmr_alloc_msg(3), rmr_call(3), rmr_init(3),
  52 rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3),
  53 rmr_rcv_specific(3), rmr_rts_msg(3), rmr_ready(3),
  54 rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3),
  55 rmr_ring_free(3)