X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_wh_state.3.rst;h=805ae7816118fbdd265d6d368644a7024a9e1422;hb=e2c0690497a2db5659b3e138e4e106d70fee4aab;hp=5b0ecaa9f98eccf0f3edec3336ed218454b70a82;hpb=117030c67f7a3722e64f1ecc3305a5862b3b7ce9;p=ric-plt%2Flib%2Frmr.git

diff --git a/docs/rmr_wh_state.3.rst b/docs/rmr_wh_state.3.rst
index 5b0ecaa..805ae78 100644
--- a/docs/rmr_wh_state.3.rst
+++ b/docs/rmr_wh_state.3.rst
@@ -1,83 +1,88 @@
- 
- 
-.. This work is licensed under a Creative Commons Attribution 4.0 International License. 
-.. SPDX-License-Identifier: CC-BY-4.0 
-.. CAUTION: this document is generated from source in doc/src/rtd. 
-.. To make changes edit the source and recompile the document. 
-.. Do NOT make changes directly to .rst or .md files. 
- 
- 
-============================================================================================ 
-Man Page: rmr_wh_state 
-============================================================================================ 
- 
-RMR Library Functions 
-============================================================================================ 
- 
- 
-NAME 
--------------------------------------------------------------------------------------------- 
- 
-rmr_wh_state 
- 
-SYNOPSIS 
--------------------------------------------------------------------------------------------- 
- 
- 
-:: 
-  
- #include <rmr/rmr.h>
- int rmr_wh_state( void* vctx, rmr_whid_t whid )
- 
- 
- 
-DESCRIPTION 
--------------------------------------------------------------------------------------------- 
- 
-The rmr_wh_state function will return the current state of 
-the connection associated with the given wormhole (whid). The 
-return value indicates whether the connection is open 
-(RMR_OK), or closed (any other return value). 
- 
-When using some transport mechanisms (e.g. NNG), it may not 
-be possible for RMR to know the actual state and the 
-connection may always be reported as "open." 
- 
-RETURN 
--------------------------------------------------------------------------------------------- 
- 
-The following values are potential return values. 
- 
- 
- 
-RMR_OK 
-   
-  The wormhole ID is valid and the connection is "open." 
-   
- 
-RMR_ERR_WHID 
-   
-  THe wormhole ID passed into the function was not valid. 
-   
- 
-RMR_ERR_NOENDPT 
-   
-  The wormhole is not open (not connected). 
-   
- 
-RMR_ERR_BADARG 
-   
-  The context passed to the function was nil or invalid. 
-   
- 
-RMR_ERR_NOWHOPEN 
-   
-  Wormholes have not been initialised (no wormhole open call 
-  has been made). 
-   
- 
- 
-SEE ALSO 
--------------------------------------------------------------------------------------------- 
- 
-rmr_wh_open(3), rmr_wh_send_msg(3), rmr_wh_close(3) 
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. CAUTION: this document is generated from source in doc/src/rtd.
+.. To make changes edit the source and recompile the document.
+.. Do NOT make changes directly to .rst or .md files.
+
+============================================================================================
+Man Page: rmr_wh_state
+============================================================================================
+
+
+
+
+RMR LIBRARY FUNCTIONS
+=====================
+
+
+
+NAME
+----
+
+rmr_wh_state
+
+
+SYNOPSIS
+--------
+
+
+::
+
+  #include <rmr/rmr.h>
+
+  int rmr_wh_state( void* vctx, rmr_whid_t whid )
+
+
+
+DESCRIPTION
+-----------
+
+The ``rmr_wh_state`` function will return the current state
+of the connection associated with the given wormhole (whid).
+The return value indicates whether the connection is open
+(RMR_OK), or closed (any other return value).
+
+When using some transport mechanisms (e.g. NNG), it may not
+be possible for RMR to know the actual state and the
+connection may always be reported as "open."
+
+
+RETURN
+------
+
+The following values are potential return values.
+
+
+    .. list-table::
+      :widths: auto
+      :header-rows: 0
+      :class: borderless
+
+      * - **RMR_OK**
+        -
+          The wormhole ID is valid and the connection is "open."
+
+      * - **RMR_ERR_WHID**
+        -
+          THe wormhole ID passed into the function was not valid.
+
+      * - **RMR_ERR_NOENDPT**
+        -
+          The wormhole is not open (not connected).
+
+      * - **RMR_ERR_BADARG**
+        -
+          The context passed to the function was nil or invalid.
+
+      * - **RMR_ERR_NOWHOPEN**
+        -
+          Wormholes have not been initialised (no wormhole open call
+          has been made).
+
+
+
+
+SEE ALSO
+--------
+
+rmr_wh_open(3), rmr_wh_send_msg(3), rmr_wh_close(3)