docs/rmr_free_msg.3.rst

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