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

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

Author: ron.sigal at jboss.com
Date: 2009-04-15 01:13:04 -0400 (Wed, 15 Apr 2009)
New Revision: 5040

Modified:
   remoting2/branches/2.x/docs/guide/en/chap5.xml
Log:
JBREM-1084: Added discussion of Client.USE_ALL_PARAMS.

Modified: remoting2/branches/2.x/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.x/docs/guide/en/chap5.xml	2009-04-15 04:37:16 UTC (rev 5039)
+++ remoting2/branches/2.x/docs/guide/en/chap5.xml	2009-04-15 05:13:04 UTC (rev 5040)
@@ -3316,6 +3316,15 @@
           <methodname>addListener()</methodname>.
         </para>
         
+        <para><emphasis role="bold">Note.</emphasis> Since release 2.5.1, if the first instance
+          of the parameter <code>org.jboss.remoting.Client.USE_ALL_PARAMS</code>
+          (actual value "useAllParams") found successively in the <classname>InvokerLocator</classname>, the
+          <classname>Client</classname>'s configuration map, or the metadata map is set
+          to "true", then polled callbacks can be configured by parameters in the 
+          <classname>InvokerLocator</classname> and <classname>Client</classname>'s 
+          configuration map as well as the metadata map passed to <methodname>addListener()</methodname>.
+        </para>
+               
         <para>
           If the client is in an environment where the server is not allowed to
           establish a network connection to the client (e.g. firewall rules
@@ -5807,6 +5816,14 @@
     javax.net.ssl.HandshakeCompletedListener implementation, which will be
     called on when ssl handshake completed with server.</para>
 
+    <para><emphasis role="bold">USE_ALL_PARAMS</emphasis>
+    (actual value is 'useAllParameters') - used by
+    <classname>org.jboss.remoting.ConnectionValidator</classname> and
+    <classname>org.jboss.remoting.callback.CallbackPoller</classname> to
+    determine if configuration parameters should be retrieved from the
+    <classname>InvokerLocator</classname> or the 
+    <classname>Client</classname>'s configuration map.</para>
+    
     <para></para>
 
     <para>The following three configuration properties are only useful when