.if false
==================================================================================
	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.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================================
.fi

.if false
	Mnemonic	rmr_wh_close.xfm
	Abstract	The manual page for the rmr_wh_close function.
	Author		E. Scott Daniels
	Date		21 February 2019
.fi

.** if formatting with tfm, the roff.im will cause roff output to be generated
.** if formatting with pfm, then pretty postscript will be generated
.gv e LIB lib
.if pfm
	.im &{lib}/generic_ps.im
.ei
	.gv e OUTPUT_RST use_rst
	.if .ev &use_rst 1 = 
		.im &{lib}/rst.im
	.ei
		.im &{lib}/roff.im
	.fi
.fi

&line_len(6i)

&h1(RMR Library Functions)
&h2(NAME)
	rmr_wh_open

&h2(SYNOPSIS)
&indent
&ex_start
#include <rmr/rmr.h>

void rmr_close( void* vctx, rmr_whid_t whid )
&ex_end

&uindent

&h2(DESCRIPTION)
The &cw(rmr_wh_close) function closes the wormhole associated with the wormhole id passed
in.  
Future calls to &cw(rmr_wh_send_msg) with this ID will fail.

&space
The underlying TCP connection to the remote endpoint is &bold(not) closed as this 
session may be reqruired for regularlly 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.


&h2(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)


.qu