X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_close.3.rst;h=ae0af1d5d86aca824d5dba2be1cffd636dbb1b06;hb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;hp=48d9033db875dd36b9fa109dfd67df583bd611ca;hpb=2b3c393e660c5e1037191f43cc70537da8316b89;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_close.3.rst b/docs/rmr_close.3.rst index 48d9033..ae0af1d 100644 --- a/docs/rmr_close.3.rst +++ b/docs/rmr_close.3.rst @@ -1,49 +1,53 @@ - - .. 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_close ============================================================================================ -RMR Library Functions -============================================================================================ - - -NAME --------------------------------------------------------------------------------------------- + + +RMR LIBRARY FUNCTIONS +===================== + + + +NAME +---- + rmr_close - -SYNOPSIS --------------------------------------------------------------------------------------------- - + + +SYNOPSIS +-------- + :: - + #include + void rmr_close( void* vctx ) - - -DESCRIPTION --------------------------------------------------------------------------------------------- - -The rmr_close function closes the listen socket effectively -cutting the application off. The route table listener is also -stopped. Calls to rmr_rcv_msg() will fail with unpredictable -error codes, and calls to rmr_send_msg(), rmr_call(), and -rmr_rts_msg() will have unknown results. - - -SEE ALSO --------------------------------------------------------------------------------------------- - + + +DESCRIPTION +----------- + +The ``rmr_close`` function closes the listen socket +effectively cutting the application off. The route table +listener is also stopped. Calls to rmr_rcv_msg() will fail +with unpredictable error codes, and calls to rmr_send_msg(), +rmr_call(), and rmr_rts_msg() will have unknown results. + + + +SEE ALSO +-------- + rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3), rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),