Add ability to save route table updates to disk

[ric-plt/lib/rmr.git] / doc / src / man / rmr_set_stimeout.3.xfm

diff --git a/doc/src/man/rmr_set_stimeout.3.xfm b/doc/src/man/rmr_set_stimeout.3.xfm
index 4f5dd35..f82b1e7 100644 (file)
--- a/doc/src/man/rmr_set_stimeout.3.xfm
+++ b/doc/src/man/rmr_set_stimeout.3.xfm
@@ -1,7 +1,7 @@
 .if false
 ==================================================================================
-    Copyright (c) 2019 Nokia
-    Copyright (c) 2018-2019 AT&T Intellectual Property.
+   Copyright (c) 2019 Nokia
+   Copyright (c) 2018-2019 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.
@@ -17,14 +17,14 @@
 ==================================================================================
 .fi
 .if false
-    Mnemonic   rmr_set_stimeout.xfm
-    Abstract   The manual page for the rmr_set_stimeout function.
-    Author             E. Scott Daniels
-    Date               28 January 2019
+    Mnemonic    rmr_set_stimeout.xfm
+    Abstract    The manual page for the rmr_set_stimeout function.
+    Author      E. Scott Daniels
+    Date        28 January 2019
 .fi
 
 .gv e LIB lib
-.im &{lib}/man/setup.im 
+.im &{lib}/man/setup.im
 
 &line_len(6i)
 
@@ -37,20 +37,20 @@
 &ex_start
 #include <rmr/rmr.h>
 
-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.
 
 
@@ -81,9 +81,9 @@ The following is a simple example of how the &cw(rmr_set_stimeout) function is c
 &ex_start
     #define NO_FLAGS    0
 
-    char*      port = "43086";     // port for message router listen
-    int                max_size = 4096;    // max message size for default allocations
-    void*      mr_context;         // message router context
+    char* port = "43086";     // port for message router listen
+    int   max_size = 4096;    // max message size for default allocations
+    void* mr_context;         // message router context
 
     mr_context = rmr_init( port, max_size, NO_FLAGS );
     if( mr_context != NULL ) {