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

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

Author: ron.sigal at jboss.com
Date: 2009-08-15 21:44:24 -0400 (Sat, 15 Aug 2009)
New Revision: 5346

Modified:
   remoting2/branches/2.x/docs/guide/en/chap5.xml
Log:
JBREM-1142:  Added discussion of the role of the "clientConnectAddress" and "clientConnectPort" parameters.

Modified: remoting2/branches/2.x/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.x/docs/guide/en/chap5.xml	2009-08-16 01:19:13 UTC (rev 5345)
+++ remoting2/branches/2.x/docs/guide/en/chap5.xml	2009-08-16 01:44:24 UTC (rev 5346)
@@ -1273,6 +1273,29 @@
       <para>If no client connect address or server bind address specified,
       will use the local host's address (via
       <code>InetAddress.getLocalHost().getHostAddress()</code> ).</para>
+      
+      <para><emphasis role="bold">Note</emphasis> The role played by "clientConnectAddress"
+      and "clientConnectPort" deserves some further elaboration.  When a server
+      is set up, it is either given an <classname>InvokerLocator</classname> explicitly,
+      or it is given enough information in an MBean XML file or a
+      <classname>ServerConfiguration</classname> POJO from which to construct an
+      <classname>InvokerLocator</classname>, and a client uses the host field and
+      port field in the <classname>InvokerLocator</classname> to determine how to connect to
+      the server.  It follows that if an explicit <classname>InvokerLocator</classname>
+      is passed to the server, then the host and port fields are either given explicitly
+      or are generated, so there is no need for "clientConnectAddress" or "clientConnectPort"
+      fields.  However, if the server is configured by way of an MBean XML file or
+      a <classname>ServerConfiguration</classname>, and no explicit 
+      <classname>InvokerLocator</classname> is specified, then the "clientConnectAddress"
+      and "clientConnectPort" parameters can be used to specify the host and port
+      fields in the <classname>InvokerLocator</classname>.  If they are omitted, then
+      the host and port fields will be derived from the values of the "serverBindAddress"
+      and "serverBindPort" parameters (or generated, if those fields are omitted).
+      Therefore, there is a role for the "clientConnectAddress" and "clientConnectPort"
+      parameters <emphasis role="bold">only if</emphasis> clients are meant to connect
+      to a host and port different than the bind host and bind port.  Such a situation
+      might occur in the presence of a translating firewall between the client and the
+      server.</para>
     </section>
 
     <section>