.if false
==================================================================================
- Copyright (c) 2019 Nokia
- Copyright (c) 2018-2019 AT&T Intellectual Property.
+ 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.
.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
+ 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
+.im &{lib}/man/setup.im
&line_len(6i)
&h1(RMR Library Functions)
&h2(NAME)
- rmr_wh_open
+ rmr_wh_close
&h2(SYNOPSIS)
&indent
&ex_start
#include <rmr/rmr.h>
-void rmr_close( void* vctx, rmr_whid_t whid )
+void rmr_wh_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.
+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).
+The underlying TCP connection to the remote endpoint is &bold(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.
&h2(SEE ALSO )
+.ju off
rmr_alloc_msg(3),
rmr_call(3),
rmr_free_msg(3),
rmr_wh_open(3),
rmr_wh_send_msg(3)
-
-.qu
-
+.ju on