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

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

Author: ron.sigal at jboss.com
Date: 2010-07-03 18:36:38 -0400 (Sat, 03 Jul 2010)
New Revision: 5904

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

Modified: remoting2/branches/2.x/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.x/docs/guide/en/chap5.xml	2010-07-03 19:33:12 UTC (rev 5903)
+++ remoting2/branches/2.x/docs/guide/en/chap5.xml	2010-07-03 22:36:38 UTC (rev 5904)
@@ -1663,14 +1663,21 @@
         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> - number of
-        retries for making invocation. It is possible that a socket connection
-        timed out while waiting within the pool. Since not doing a connection
-        check by default, will throw away the connection and try to get a new
-        one. Will do this for numberOfCallRetries times (which defaults to 3).
-        If still fails, will throw an
-        <classname>org.jboss.remoting.InvocationFailureException</classname>,
-        with the cause being the original exception.</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>
+         
+        <para><emphasis role="bold">generalizeSocketException</emphasis> -
+        If set to false, a failed invocation will be retried in the case of
+        <classname>SocketException</classname>s.
+        If set to true, a failed invocation will be retried in the case of
+        <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>
   
         <para><emphasis role="bold">clientSocketClass</emphasis> - specifies the
         fully qualified class name for the custom SocketWrapper implementation