X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_free_msg.3.rst;h=833dc28714ff136a97c120ba8f47996ac607a8ae;hb=4f3e23473e3453d4b9c24d1cd727c481e5f59c74;hp=b35905c65ddc6340b51e44e4c4411bf62a9276e8;hpb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_free_msg.3.rst b/docs/rmr_free_msg.3.rst index b35905c..833dc28 100644 --- a/docs/rmr_free_msg.3.rst +++ b/docs/rmr_free_msg.3.rst @@ -1,14 +1,14 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 -.. CAUTION: this document is generated from source in doc/src/rtd. -.. To make changes edit the source and recompile the document. -.. Do NOT make changes directly to .rst or .md files. - -============================================================================================ -Man Page: rmr_free_msg -============================================================================================ - - +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. CAUTION: this document is generated from source in doc/src/rtd. +.. To make changes edit the source and recompile the document. +.. Do NOT make changes directly to .rst or .md files. + +============================================================================================ +Man Page: rmr_free_msg +============================================================================================ + + RMR LIBRARY FUNCTIONS @@ -19,41 +19,41 @@ RMR LIBRARY FUNCTIONS NAME ---- -rmr_free_msg +rmr_free_msg SYNOPSIS -------- - -:: - - #include - - void rmr_free_msg( rmr_mbuf_t* mbuf ); - + +:: + + #include + + void rmr_free_msg( rmr_mbuf_t* mbuf ); + 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 ``errrno.`` - -After calling, the user application should **not** use any of -the pointers (transaction ID, or payload) which were -available. +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 ``errrno.`` + +After calling, the user application should **not** use any of +the pointers (transaction ID, or payload) which were +available. SEE ALSO -------- -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) +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)