[jboss-remoting-commits] JBoss Remoting SVN: r5905 - remoting2/branches/2.2/docs/guide/en.

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

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

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

Modified: remoting2/branches/2.2/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.2/docs/guide/en/chap5.xml	2010-07-03 22:36:38 UTC (rev 5904)
+++ remoting2/branches/2.2/docs/guide/en/chap5.xml	2010-07-03 22:54:03 UTC (rev 5905)
@@ -1105,19 +1105,28 @@
       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.  Note that after numberOfCallRetries - 2 attempts,
+      the connection pool will be flushed on the assumption that all connections
+      are invalid.  After numberOfCallRetries attempts, a 
+      <classname>MarshalException</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.
+      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>.'
+      See also the "numberOfCallRetries" parameter, above. The default value is
+      false.</para>
 
-      <para><emphasis role="bold">numberOfCallRetries</emphasis> - number of
-      retries for making invocation. It is possible that an existing 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 whatever the numberOfCallRetries (which
-      defaults to 3) is. However, when reaches numberOfCallsRetries - 2, will
-      flush the entire connection pool under the assumption that all
-      connections in the pool have timed out and are invalid and will start
-      over by creating a new connection. If still fails, will throw
-      MarshalException with the cause being the original
-      SocketException.</para>
-
       <para><emphasis role="bold">clientSocketClass</emphasis> - specifies the
       fully qualified class name for the custom SocketWrapper implementation
       to use on the client. Note, will need to make sure this is marked as a