.if false
==================================================================================
- Copyright (c) 2020 Nokia
- Copyright (c) 2020 AT&T Intellectual Property.
+ Copyright (c) 2020 Nokia
+ Copyright (c) 2020 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_state.xfm
- Abstract The manual page for the rmr_wh_state function.
- Author E. Scott Daniels
- Date 6 March 2020
+ Mnemonic rmr_wh_state.xfm
+ Abstract The manual page for the rmr_wh_state function.
+ Author E. Scott Daniels
+ Date 6 March 2020
.fi
.gv e LIB lib
-.im &{lib}/man/setup.im
+.im &{lib}/man/setup.im
&line_len(6i)
&h1(RMR Library Functions)
&h2(NAME)
- rmr_wh_state
+ rmr_wh_state
&h2(SYNOPSIS)
&indent
&h2(DESCRIPTION)
The &cw(rmr_wh_state) function will return the current state of the connection
-associated with the given wormhole (whid).
+associated with the given wormhole (whid).
The return value indicates whether the connection is open (RMR_OK), or closed
(any other return value).
&space
&beg_dlist(.75i : ^&bold_font )
-&di(RMR_OK)
- The wormhole ID is valid and the connection is "open."
- &half_space
+&ditem(RMR_OK)
+ The wormhole ID is valid and the connection is "open."
-&di(RMR_ERR_WHID)
- THe wormhole ID passed into the function was not valid.
- &half_space
+&ditem(RMR_ERR_WHID)
+ THe wormhole ID passed into the function was not valid.
-&di(RMR_ERR_NOENDPT)
- The wormhole is not open (not connected).
- &half_space
+&ditem(RMR_ERR_NOENDPT)
+ The wormhole is not open (not connected).
-&di(RMR_ERR_BADARG)
- The context passed to the function was nil or invalid.
- &half_space
+&ditem(RMR_ERR_BADARG)
+ The context passed to the function was nil or invalid.
-&di(RMR_ERR_NOWHOPEN)
- Wormholes have not been initialised (no wormhole open call has been made).
- &half_space
+&ditem(RMR_ERR_NOWHOPEN)
+ Wormholes have not been initialised (no wormhole open call has been made).
&end_dlist