docs/rmr_wh_state.3.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. CAUTION: this document is generated from source in doc/src/rtd.
   4 .. To make changes edit the source and recompile the document.
   5 .. Do NOT make changes directly to .rst or .md files.
   6
   7 ============================================================================================
   8 Man Page: rmr_wh_state
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_wh_state
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   int rmr_wh_state( void* vctx, rmr_whid_t whid )
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  40 The ``rmr_wh_state`` function will return the current state
  41 of the connection associated with the given wormhole (whid).
  42 The return value indicates whether the connection is open
  43 (RMR_OK), or closed (any other return value).
  44
  45 When using some transport mechanisms (e.g. NNG), it may not
  46 be possible for RMR to know the actual state and the
  47 connection may always be reported as "open."
  48
  49
  50 RETURN
  51 ------
  52
  53 The following values are potential return values.
  54
  55
  56     .. list-table::
  57       :widths: auto
  58       :header-rows: 0
  59       :class: borderless
  60
  61       * - **RMR_OK**
  62         -
  63           The wormhole ID is valid and the connection is "open."
  64
  65       * - **RMR_ERR_WHID**
  66         -
  67           THe wormhole ID passed into the function was not valid.
  68
  69       * - **RMR_ERR_NOENDPT**
  70         -
  71           The wormhole is not open (not connected).
  72
  73       * - **RMR_ERR_BADARG**
  74         -
  75           The context passed to the function was nil or invalid.
  76
  77       * - **RMR_ERR_NOWHOPEN**
  78         -
  79           Wormholes have not been initialised (no wormhole open call
  80           has been made).
  81
  82
  83
  84
  85 SEE ALSO
  86 --------
  87
  88 rmr_wh_open(3), rmr_wh_send_msg(3), rmr_wh_close(3)