2 ==================================================================================
3 Copyright (c) 2019 Nokia
4 Copyright (c) 2018-2019 AT&T Intellectual Property.
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
10 http://www.apache.org/licenses/LICENSE-2.0
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 ==================================================================================
21 Mnemonic rmr_free_msg_man.xfm
22 Abstract The manual page for the rmr_free_msg function.
23 Author E. Scott Daniels
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
31 .im &{lib}/generic_ps.im
33 .gv e OUTPUT_RST use_rst
43 &h1(RMR Library Functions)
52 void rmr_free_msg( rmr_mbuf_t* mbuf );
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
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.)
65 After calling, the user application should &bold(not) use any of the
66 pointers (transaction ID, or payload) which were available.