.if false
==================================================================================
	Copyright (c) 2019 Nokia 
	Copyright (c) 2018-2019 AT&T Intellectual Property.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================================
.fi

.if false
	Mnemonic	rmr_free_msg_man.xfm
	Abstract	The manual page for the rmr_free_msg function.
	Author		E. Scott Daniels
	Date		28 January 2019
.fi

.gv e LIB lib
.im &{lib}/man/setup.im 

&line_len(6i)

&h1(RMR Library Functions)
&h2(NAME)
	rmr_free_msg

&h2(SYNOPSIS )
&indent
&ex_start
#include <rmr/rmr.h>

void rmr_free_msg( rmr_mbuf_t* mbuf );
&ex_end
&uindent

&h2(DESCRIPTION)
The message buffer is returned to the pool, or the associated memory is
released depending on the needs of the underlying messaging system. 
This allows the user application to release a buffer that is not going 
to be used.
It is safe to pass a nil pointer to this function, and doing so does 
not result in a change to the value of &cw(errrno.)
&space

After calling, the user application should &bold(not) use any of the 
pointers (transaction ID, or payload) which were available.


&h2(SEE ALSO )
.ju off
rmr_alloc_msg(3),
rmr_call(3),
rmr_init(3),
rmr_payload_size(3),
rmr_send_msg(3),
rmr_rcv_msg(3),
rmr_rcv_specific(3),
rmr_rts_msg(3),
rmr_ready(3),
rmr_fib(3),
rmr_has_str(3),
rmr_tokenise(3),
rmr_mk_ring(3),
rmr_ring_free(3)
.ju on