2 ==================================================================================
3 Copyright (c) 2020 Nokia
4 Copyright (c) 2020 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_state.xfm
22 Abstract The manual page for the rmr_wh_state function.
23 Author E. Scott Daniels
28 .im &{lib}/man/setup.im
32 &h1(RMR Library Functions)
41 int rmr_wh_state( void* vctx, rmr_whid_t whid )
47 The &cw(rmr_wh_state) function will return the current state of the connection
48 associated with the given wormhole (whid).
49 The return value indicates whether the connection is open (RMR_OK), or closed
50 (any other return value).
53 When using some transport mechanisms (e.g. NNG), it may not be possible for
54 RMR to know the actual state and the connection may always be reported as
58 The following values are potential return values.
61 &beg_dlist(.75i : ^&bold_font )
63 The wormhole ID is valid and the connection is "open."
66 THe wormhole ID passed into the function was not valid.
68 &ditem(RMR_ERR_NOENDPT)
69 The wormhole is not open (not connected).
71 &ditem(RMR_ERR_BADARG)
72 The context passed to the function was nil or invalid.
74 &ditem(RMR_ERR_NOWHOPEN)
75 Wormholes have not been initialised (no wormhole open call has been made).