Add manual page for set low latency funciton

[ric-plt/lib/rmr.git] / doc / src / man / retry.im

diff --git a/doc/src/man/retry.im b/doc/src/man/retry.im
index 7ffd34a..60e10bc 100644 (file)
--- a/doc/src/man/retry.im
+++ b/doc/src/man/retry.im
@@ -1,7 +1,7 @@
 .if false
 ==================================================================================
 .if false
 ==================================================================================

-   Copyright (c) 2019 Nokia
-   Copyright (c) 2018-2019 AT&T Intellectual Property.
+   Copyright (c) 2019-2020 Nokia
+   Copyright (c) 2018-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.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.


@@ -30,15 +30,19 @@ The send operations in RMR will retry &ital(soft) send failures until one of thr
 conditions occurs:
 &half_space
 &indent
 conditions occurs:
 &half_space
 &indent

-&beg_dlist( 0.3i : ^&bold_font )
-    &di(1.) The message is sent without error
-    &half_space

 
 

-    &di(2.) The underlying transport reports a &ital(hard) failure
-    &half_space
+&beg_list(&lic1)
+&item
+    The message is sent without error

 
 

-    &di(3.) The maximum number of retry loops has been attempted
-    &end_dlist
+&half_space
+&item
+    The underlying transport reports a &ital(hard) failure
+
+&half_space
+&item
+    The maximum number of retry loops has been attempted
+&end_list

 &uindent
 
 &space
 &uindent
 
 &space


@@ -46,7 +50,7 @@ A retry loop consists of approximately 1000 send attempts &bold(without) any int
 calls to &ital(sleep()) or &ital(usleep().)
 The number of retry loops defaults to 1, thus a maximum of 1000 send attempts is performed
 before returning to the user application.
 calls to &ital(sleep()) or &ital(usleep().)
 The number of retry loops defaults to 1, thus a maximum of 1000 send attempts is performed
 before returning to the user application.

-This value can be set at any point after RMr initialisation using the &ital(rmr_set_stimeout())
+This value can be set at any point after RMR initialisation using the &ital(rmr_set_stimeout())

 function allowing the user application to completely disable retires (set to 0), or to
 increase the number of retry loops.
 
 function allowing the user application to completely disable retires (set to 0), or to
 increase the number of retry loops.