X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_set_stimeout.3.rst;h=ceb7d4bb813e641e78ee7aa95c1b0efb3db76d57;hb=2b3c393e660c5e1037191f43cc70537da8316b89;hp=31b9c8046e1d0e5f6dae34fc75f686a0fa072a90;hpb=503fe41e88b66ff8986c991bfbd075331b0bd166;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_set_stimeout.3.rst b/docs/rmr_set_stimeout.3.rst index 31b9c80..ceb7d4b 100644 --- a/docs/rmr_set_stimeout.3.rst +++ b/docs/rmr_set_stimeout.3.rst @@ -27,7 +27,7 @@ SYNOPSIS :: #include - rmr_mbuf_t* rmr_set_stimeout( void* vctx, int rloops ); + int rmr_set_stimeout( void* vctx, int rloops ); @@ -35,14 +35,14 @@ DESCRIPTION -------------------------------------------------------------------------------------------- The rmr_set_stimeout function sets the configuration for how -RMr will retry message send operations which complete with +RMR will retry message send operations which complete with either a *timeout* or *again* completion value. (Send operations include all of the possible message send functions: *rmr_send_msg(), rmr_call(), rmr_rts_msg()* and *rmr_wh_send_msg().* The *rloops* parameter sets the maximum number of retry loops that will be attempted before giving up and returning the unsuccessful state to the user application. -Each retry loop is approximately 1000 attempts, and RMr does +Each retry loop is approximately 1000 attempts, and RMR does **not** invoke any sleep function between retries in the loop; a small, 1 mu-sec, sleep is executed between loop sets if the *rloops* value is greater than 1. @@ -58,7 +58,7 @@ user application does not want to have send operations retry when the underlying transport mechanism indicates *timeout* or *again,* the application should invoke this function and pass a value of 0 (zero) for *rloops.* With this setting, all -RMr send operations will attempt a send operation only +RMR send operations will attempt a send operation only **once,** returning immediately to the caller with the state of that single attempt.