[jboss-remoting-commits] JBoss Remoting SVN: r5344 - 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:13:58 -0400 (Sat, 15 Aug 2009)
New Revision: 5344

Modified:
   remoting2/branches/2.x/docs/guide/en/chap5.xml
Log:
JBREM-1139: Added paragraph about adjustability of PortUtil search range.

Modified: remoting2/branches/2.x/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.x/docs/guide/en/chap5.xml	2009-08-15 03:22:19 UTC (rev 5343)
+++ remoting2/branches/2.x/docs/guide/en/chap5.xml	2009-08-16 01:13:58 UTC (rev 5344)
@@ -1322,6 +1322,23 @@
       because either the serverBindPort or the original InvokerLocator port
       value was either 0 or negative, the InvokerLocator will be updated to
       reflect the new port value.</para>
+      
+      <para><emphasis role="bold">Note.</emphasis> 
+      In the case that a bind port isn't specified, the utility class
+      <classname>org.jboss.remoting.transport.PortUtil</classname> is used to 
+      supply an available port.  By default, it will look for a port in the range
+      1024 to 65535, inclusively.  As of release 2.5.2, PortUtil can be configured
+      to search a smaller range by setting the values PortUtil.MIN_PORT (actual
+      value "minPort") and / or PortUtil.MAX_PORT (actual value "maxPort") in
+      the InvokerLocator, a configuration map, an MBean XML file, or a 
+      <classname>ServerConfiguration</classname> object.  The range is static;
+      that is, whenever "minPort" or "maxPort" are set, they affect all
+      subsequent calls in the JVM.  Note that <classname>PortUtil</classname>
+      will apply a new "minPort" value only if it is greater than the current
+      value, and it will apply a new "maxPort" value only if it is less than
+      the current value.  And it will never apply a new value when the result
+      would be such that the value of "maxPort" would be less than the value
+      of "minPort".</para> 
     </section>
 
     <section>