X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_wh_state.3.xfm;h=70780c62f379c5c774ddc2e1b504272c403a75c9;hb=5157a97ada5447efcee4da6192798a3b6799884c;hp=ea4c960befeaf55b0194798a4247795a629bfcb5;hpb=708ebac12488fe6fb204ff2861fc0045afb73b78;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_wh_state.3.xfm b/doc/src/man/rmr_wh_state.3.xfm index ea4c960..70780c6 100644 --- a/doc/src/man/rmr_wh_state.3.xfm +++ b/doc/src/man/rmr_wh_state.3.xfm @@ -1,7 +1,7 @@ .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. @@ -18,20 +18,20 @@ .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 @@ -45,7 +45,7 @@ int rmr_wh_state( void* vctx, rmr_whid_t whid ) &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). @@ -59,25 +59,25 @@ The following values are potential return values. &space &beg_dlist(.75i : ^&bold_font ) -&di(RMR_OK) - The wormhole ID is valid and the connection is "open." - &half_space +&di(RMR_OK) + The wormhole ID is valid and the connection is "open." + &half_space &di(RMR_ERR_WHID) - THe wormhole ID passed into the function was not valid. - &half_space + THe wormhole ID passed into the function was not valid. + &half_space &di(RMR_ERR_NOENDPT) - The wormhole is not open (not connected). - &half_space + The wormhole is not open (not connected). + &half_space &di(RMR_ERR_BADARG) - The context passed to the function was nil or invalid. - &half_space + The context passed to the function was nil or invalid. + &half_space &di(RMR_ERR_NOWHOPEN) - Wormholes have not been initialised (no wormhole open call has been made). - &half_space + Wormholes have not been initialised (no wormhole open call has been made). + &half_space &end_dlist