X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_free_msg.3.xfm;h=000856caa3fcd6a37f7a01c5114dea6e6b80850c;hb=5157a97ada5447efcee4da6192798a3b6799884c;hp=5c0fd91add6501105d4a8ea999dce4e0456d47ae;hpb=523a17b2ea5e380b5360e00828556e8b3872e33d;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_free_msg.3.xfm b/doc/src/man/rmr_free_msg.3.xfm index 5c0fd91..000856c 100644 --- a/doc/src/man/rmr_free_msg.3.xfm +++ b/doc/src/man/rmr_free_msg.3.xfm @@ -1,7 +1,7 @@ .if false ================================================================================== - Copyright (c) 2019 Nokia - Copyright (c) 2018-2019 AT&T Intellectual Property. + 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. @@ -18,20 +18,20 @@ .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 + 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 +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_free_msg + rmr_free_msg &h2(SYNOPSIS ) &indent @@ -44,18 +44,19 @@ void rmr_free_msg( rmr_mbuf_t* mbuf ); &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 +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 +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 +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), @@ -70,7 +71,5 @@ rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3), rmr_ring_free(3) - - -.qu +.ju on