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

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

Author: ron.sigal at jboss.com
Date: 2009-04-14 21:31:36 -0400 (Tue, 14 Apr 2009)
New Revision: 5036

Modified:
   remoting2/branches/2.2/docs/guide/en/chap8.xml
Log:
JBREM-1082: Added reference to Client.USE_ALL_PARAMETERS; (2) JBREM-1112: added reference to FAILURE_DISCONNECT_TIMEOUT; (3) JBREM-1108: noted validatorPingPeriod should be longer than validatorPingTimeout.

Modified: remoting2/branches/2.2/docs/guide/en/chap8.xml
===================================================================
--- remoting2/branches/2.2/docs/guide/en/chap8.xml	2009-04-15 01:30:20 UTC (rev 5035)
+++ remoting2/branches/2.2/docs/guide/en/chap8.xml	2009-04-15 01:31:36 UTC (rev 5036)
@@ -57,13 +57,46 @@
     "validatorPingTimeout") - specifies the time, in milliseconds, allowed for
     arrival of a response to a PING message. The default value is 1000.</para> 
     
-    <para>For more configuration parameters, see <xref
-    linkend="section-interactions"/>.</para>
+    <para><emphasis role="bold">FAILURE_DISCONNECT_TIMEOUT</emphasis> (actual value
+    "failureDisconnectTimeout") - if the parameter "stopLeaseOnFailure" 
+    (see <xref linkend="section-interactions"/>) is set to
+    "true", then "failureDisconnectTimeout" determines the disconnect timeout value
+    to be used by <classname>org.jboss.remoting.LeasePinger</classname> in shutting
+    down.  In particular, if "failureDisconnectTimeout" is set to "0", then 
+    <classname>LeasePinger</classname> will avoid any network i/o.</para>
     
-    <para>Note, also, that <classname>ConnectionValidator</classname> creates a
+    <para> Normally, the values for these parameters are obtained either from
+    the <classname>Client</classname>'s configuration map or the metadata map
+    passed to <methodname>addConnectionListener()</methodname>, with values in
+    the metadata map taking precedence. However, another relevant parameter is
+    defined in <classname>org.jboss.remoting.Client</classname>:</para>
+    
+    <para><emphasis role="bold">USE_ALL_PARAMS</emphasis> (actual value
+    "useAllParams") - this parameter is searched for in the
+    <classname>InvokerLocator</classname>, in the configuration map passed to
+    the <classname>Client</classname>, and in the metadata map (in that order).
+    If the last occurrence found is set to "true", then parameter values are
+    first obtained from the <classname>InvokerLocator</classname>, followed by
+    the <classname>Client</classname>'s configuration map and the
+    metadata map.</para>
+    
+    <para>Note that <classname>ConnectionValidator</classname> creates a
     client invoker to sends the PING messages, and it passes the metadata map to
     configure the client invoker.</para>
     
+    <para><emphasis role="bold">NOTE.</emphasis> The default values of VALIDATOR_PING_PERIOD
+    and VALIDATOR_PING_TIMEOUT have often been found in practice to be too small, increasing
+    the likelihood of spurious connection failures.</para>
+    
+    <para><emphasis role="bold">NOTE.</emphasis> It is important to set VALIDATOR_PING_PERIOD
+    to a value greater than the value of VALIDATOR_PING_TIMEOUT.  Doing so gives the
+    <classname>ConnectionValidator</classname> a chance to notify all
+    <classname>ConnectionListener</classname>s, which might result in shutting down the
+    connection, before the next PING is sent.</para>
+    
+    <para>For more configuration parameters, see <xref
+    linkend="section-interactions"/>.</para>
+    
   </section>
 
   <section id="section-server-side" xreflabel="Server side monitoring">
@@ -94,7 +127,7 @@
     
     <programlisting>public void addConnectionListener(ConnectionListener listener)</programlisting>
     
-    <para>or though the use of the
+    <para>or through the use of the
     <code>ServerInvoker.CONNECTION_LISTENER</code> parameter (actual value
     "connectionListener") in the <classname>Connector</classname>'s
     configuration map or XML configuration file. Once both criteria are met, the