X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_wh_close.3.rst;h=64faa6978fc1d0580ed8db5e70616947033a152f;hb=c8c5946b142c5cc04449edc49a599f282c6573e4;hp=3741babe086f2ef21d1a55f99bf8345e803c59e7;hpb=0ccfca870ea9f7bdaba1ee3a02822051fea6cabd;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_wh_close.3.rst b/docs/rmr_wh_close.3.rst index 3741bab..64faa69 100644 --- a/docs/rmr_wh_close.3.rst +++ b/docs/rmr_wh_close.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_wh_close -============================================================================================ - - +.. 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_wh_close +============================================================================================ + + RMR LIBRARY FUNCTIONS @@ -19,41 +19,41 @@ RMR LIBRARY FUNCTIONS NAME ---- -rmr_wh_close +rmr_wh_close SYNOPSIS -------- - -:: - - #include - - void rmr_wh_close( void* vctx, rmr_whid_t whid ) - + +:: + + #include + + void rmr_wh_close( void* vctx, rmr_whid_t whid ) + DESCRIPTION ----------- -The ``rmr_wh_close`` function closes the wormhole associated -with the wormhole id passed in. Future calls to -``rmr_wh_send_msg`` with this ID will fail. - -The underlying TCP connection to the remote endpoint is -**not** closed as this session may be required for regularly -routed messages (messages routed based on message type). -There is no way to force a TCP session to be closed at this -point in time. +The ``rmr_wh_close`` function closes the wormhole associated +with the wormhole id passed in. Future calls to +``rmr_wh_send_msg`` with this ID will fail. + +The underlying TCP connection to the remote endpoint is +**not** closed as this session may be required for regularly +routed messages (messages routed based on message type). +There is no way to force a TCP session to be closed at this +point in time. 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) +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)