2 ==================================================================================
3 Copyright (c) 2019 Nokia
4 Copyright (c) 2018-2019 AT&T Intellectual Property.
6 Licensed under the Apache License, Version 2.0 (the "License");
7 you may not use this file except in compliance with the License.
8 You may obtain a copy of the License at
10 http://www.apache.org/licenses/LICENSE-2.0
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS,
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 See the License for the specific language governing permissions and
16 limitations under the License.
17 ==================================================================================
21 Mnemonic rmr_wh_close.xfm
22 Abstract The manual page for the rmr_wh_close function.
23 Author E. Scott Daniels
27 .** if formatting with tfm, the roff.im will cause roff output to be generated
28 .** if formatting with pfm, then pretty postscript will be generated
31 .im &{lib}/generic_ps.im
33 .gv e OUTPUT_RST use_rst
43 &h1(RMR Library Functions)
52 void rmr_close( void* vctx, rmr_whid_t whid )
58 The &cw(rmr_wh_close) function closes the wormhole associated with the wormhole id passed
60 Future calls to &cw(rmr_wh_send_msg) with this ID will fail.
63 The underlying TCP connection to the remote endpoint is &bold(not) closed as this
64 session may be reqruired for regularlly routed messages (messages routed based on message
66 There is no way to force a TCP session to be closed at this point in time.