[jboss-remoting-commits] JBoss Remoting SVN: r5906 - remoting2/branches/2.x/docs/guide/en.

[jboss-remoting-commits at lists.jboss.org]

Author: ron.sigal at jboss.com
Date: 2010-07-03 19:00:17 -0400 (Sat, 03 Jul 2010)
New Revision: 5906

Modified:
   remoting2/branches/2.x/docs/guide/en/chap5.xml
Log:
JBREM-1219: Extended discussion of "numberOfCallRetries" and "generalizeSocketException".

Modified: remoting2/branches/2.x/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.x/docs/guide/en/chap5.xml	2010-07-03 22:54:03 UTC (rev 5905)
+++ remoting2/branches/2.x/docs/guide/en/chap5.xml	2010-07-03 23:00:17 UTC (rev 5906)
@@ -1662,14 +1662,18 @@
         side maximum number of active socket connections. This basically equates
         to the maximum number of concurrent client calls that can be made from
         the socket client invoker. The default is 50.</para>
-  
+
         <para><emphasis role="bold">numberOfCallRetries</emphasis> - the number of
         times a failed invocation will be retried. For example, it is possible that the
         server side of a socket connection could time out, leaving the connection
         invalid.  In that case, the socket will be discarded and another, possibly
-        new, socket will be used.  The default value is 3.  See also the
-        parameter generalizeSocketException, below</para>
-         
+        new, socket will be used.  Note that after numberOfCallRetries - 2 attempts,
+        the connection pool will be flushed on the assumption that all connections
+        are invalid.  After numberOfCallRetries attempts, an
+        <classname>InvocationFailureException</classname>, whose cause is the original
+        exception, will be thrown.  The default value is 3.  See also the
+        "generalizeSocketException" parameter, below</para>
+               
         <para><emphasis role="bold">generalizeSocketException</emphasis> -
         If set to false, a failed invocation will be retried in the case of
         <classname>SocketException</classname>s.
@@ -1677,7 +1681,8 @@
         <classname>SocketException</classname>s and also any <classname>IOException</classname>
         whose message matches the regular expression
         <code>^.*(?:connection.*reset|connection.*closed|broken.*pipe).*$</code>.
-        The default value is false.</para>
+        See also the "numberOfCallRetries" parameter, above. The default value is
+        false.</para>
   
         <para><emphasis role="bold">clientSocketClass</emphasis> - specifies the
         fully qualified class name for the custom SocketWrapper implementation