X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_close.3.rst;h=2ddc025db0058d9b8111b91b89d3ef2ed86bc677;hb=c8e651e15839411c85e105d16fd2ffc14c1cc1dd;hp=48d9033db875dd36b9fa109dfd67df583bd611ca;hpb=503fe41e88b66ff8986c991bfbd075331b0bd166;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_close.3.rst b/docs/rmr_close.3.rst index 48d9033..2ddc025 100644 --- a/docs/rmr_close.3.rst +++ b/docs/rmr_close.3.rst @@ -1,52 +1,56 @@ - - -.. 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_close - -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 --------------------------------------------------------------------------------------------- - -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), -rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), -rmr_mk_ring(3), rmr_ring_free(3), rmr_wh_open(3), -rmr_wh_send_msg(3) +.. 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_close + + +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 +-------- + +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), +rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), +rmr_mk_ring(3), rmr_ring_free(3), rmr_wh_open(3), +rmr_wh_send_msg(3)