Code Review / ric-plt / lib / rmr.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Eliminate the SI receive buffer length requirement
[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 5550d24..ce587c1 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
 ==================================================================================
 .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.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -17,25 +17,14 @@
 ==================================================================================
 .fi
 .if false
 ==================================================================================
 .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
 
 .fi
 
-.** if formatting with tfm, the roff.im will cause roff output to be generated
-.** if formatting with pfm, then pretty postscript will be generated
 .gv e LIB lib
 .gv e LIB lib
-.if pfm
-    .im &{lib}/generic_ps.im
-.ei
-    .gv e OUTPUT_RST use_rst
-    .if .ev &use_rst 1 =
-       .im &{lib}/rst.im
-    .ei
-       .im &{lib}/roff.im
-    .fi
-.fi
+.im &{lib}/man/setup.im
 
 &line_len(6i)
 
 
 &line_len(6i)
 
@@ -55,35 +44,35 @@ rmr_mbuf_t* rmr_set_stimeout( void* vctx, int rloops );
 
 &h2(DESCRIPTION)
 The &cw(rmr_set_stimeout) function sets the configuration for how RMr will retry
 
 &h2(DESCRIPTION)
 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 )
+message send operations which complete with either a &ital(timeout)  or &ital(again)
 completion value.  (Send operations include all of the possible message send
 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
+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.
 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
 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.
+sets if the &ital(rloops) value is greater than 1.
 
 .sp
 &h3(Disabling Retries)
 
 .sp
 &h3(Disabling Retries)
-By default, the send operations will execute with an &ital( rloop ) setting of 1; each send
+By default, the send operations will execute with an &ital(rloop) setting of 1; each send
 operation will attempt to resend the message approximately 1000 times before giving up.
 If the user application does not want to have send operations retry when the underlying
 operation will attempt to resend the message approximately 1000 times before giving up.
 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, )
+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,)
 returning immediately to the caller with the state of that single attempt.
 
 
 &h2(RETURN VALUE)
 returning immediately to the caller with the state of that single attempt.
 
 
 &h2(RETURN VALUE)
-This function returns a -1 to indicate that the &ital( rloops ) value could not be set, and
-the value &ital( RMR_OK ) to indicate success.
+This function returns a -1 to indicate that the &ital(rloops) value could not be set, and
+the value &ital(RMR_OK) to indicate success.
 
 
 &h2(ERRORS)
 
 
 &h2(ERRORS)
-Currently errno is &bold( not ) set by this function; the only cause of a failure is an
-invalid context ( .sm &ital( vctx ) .sm ) pointer.
+Currently errno is &bold(not) set by this function; the only cause of a failure is an
+invalid context ( .sm &ital(vctx) .sm ) pointer.
 
 &h2(EXAMPLE)
 The following is a simple example of how the &cw(rmr_set_stimeout) function is called.
 
 &h2(EXAMPLE)
 The following is a simple example of how the &cw(rmr_set_stimeout) function is called.
@@ -92,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
 
 &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 ) {
 
     mr_context = rmr_init( port, max_size, NO_FLAGS );
     if( mr_context != NULL ) {
@@ -121,7 +110,3 @@ rmr_send_msg(3),
 rmr_torcv_rcv(3),
 rmr_wh_send_msg(3)
 .ju on
 rmr_torcv_rcv(3),
 rmr_wh_send_msg(3)
 .ju on
-
-
-.qu
-
An library for low latency message routing based on message type