X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_set_stimeout.3.xfm;h=f82b1e7afed30988f2c8b55bf5bd67cb983fdcdd;hb=0f231bf2bf5520a418156c965c669e411875dcf0;hp=ce587c1d11be5fdad5594af5e7c341639c75ba78;hpb=5157a97ada5447efcee4da6192798a3b6799884c;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_set_stimeout.3.xfm b/doc/src/man/rmr_set_stimeout.3.xfm index ce587c1..f82b1e7 100644 --- a/doc/src/man/rmr_set_stimeout.3.xfm +++ b/doc/src/man/rmr_set_stimeout.3.xfm @@ -37,20 +37,20 @@ &ex_start #include -rmr_mbuf_t* rmr_set_stimeout( void* vctx, int rloops ); +int rmr_set_stimeout( void* vctx, int rloops ); &ex_end &uindent &h2(DESCRIPTION) -The &cw(rmr_set_stimeout) function sets the configuration for how RMr will retry +The &cw(rmr_set_stimeout) function sets the configuration for how RMR will retry message send operations which complete with either a &ital(timeout) or &ital(again) completion value. (Send operations include all of the possible message send functions: &ital(rmr_send_msg(), rmr_call(), rmr_rts_msg()) and &ital(rmr_wh_send_msg().) The &ital(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 &bold(not) invoke any sleep +Each retry loop is approximately 1000 attempts, and RMR does &bold(not) invoke any sleep function between retries in the loop; a small, 1 mu-sec, sleep is executed between loop sets if the &ital(rloops) value is greater than 1. @@ -61,7 +61,7 @@ operation will attempt to resend the message approximately 1000 times before giv If the user application does not want to have send operations retry when the underlying transport mechanism indicates &ital(timeout) or &ital(again,) the application should invoke this function and pass a value of 0 (zero) for &ital(rloops.) -With this setting, all RMr send operations will attempt a send operation only &bold(once,) +With this setting, all RMR send operations will attempt a send operation only &bold(once,) returning immediately to the caller with the state of that single attempt.