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

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

Author: ron.sigal at jboss.com
Date: 2008-05-28 20:08:02 -0400 (Wed, 28 May 2008)
New Revision: 4256

Modified:
   remoting2/branches/2.x/docs/guide/en/chap5.xml
Log:
JBREM-840: Added MicroSocketClientInvoker.USE_ONEWAY_CONNECTION_TIMEOUT parameter.

Modified: remoting2/branches/2.x/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.x/docs/guide/en/chap5.xml	2008-05-28 23:25:45 UTC (rev 4255)
+++ remoting2/branches/2.x/docs/guide/en/chap5.xml	2008-05-29 00:08:02 UTC (rev 4256)
@@ -1619,15 +1619,15 @@
         re-using it by sending a single byte ping from the client to the server
         and then back from the server. This config needs to be set on both
         client and server to work. This if false by default.</para>
-  
-        <para>An example of locator uri for a socket invoker that has
-        TCP_NODELAY set to false and the client's max pool size of 30 would
-        be:</para>
-  
-        <para><code>
-        socket://test.somedomain.com:8084/?enableTcpNoDelay=false&amp;maxPoolSize=30
-        </code></para>
         
+        <para><emphasis role="bold">useOnewayConnectionTimeout</emphasis> -
+        indicates if, during a client side oneway invocation,
+        <classname>MicroSocketClientInvoker</classname> should wait for a
+        version byte from the server, which prevents the anomalous behavior
+        described in JBREM-706 "In socket transport, prevent client side oneway
+        invocations from artificially reducing concurrency". The default value
+        is "true".</para>
+        
         <para><emphasis role="bold">Note.</emphasis> As of Remoting version 2.4,
         the following socket parameters, in addition to SO_TIMEOUT and
         TCP_NODELAY, can be configured on the client client side: SO_KEEPALIVE,
@@ -6533,7 +6533,14 @@
     'isParam' attribute). Making this change will not affect the
     marshaller/unmarshaller that is used, which may also be a
     requirement.</para>
-
+    
+    <para><emphasis role="bold">USE_ONEWAY_CONNECTION_TIMEOUT</emphasis> (actual value "useOnewayConnectionTimeout") -
+    indicates if, during a client side oneway invocation,
+    <classname>MicroSocketClientInvoker</classname> should wait for a version
+    byte from the server, which prevents the anomalous behavior described in
+    JBREM-706 "In socket transport, prevent client side oneway invocations from
+    artificially reducing concurrency". The default value is "true".</para>
+    
     </section>
     
     <section>
@@ -6563,6 +6570,7 @@
     <para><emphasis role="bold">SERVER_SOCKET_CLASS_FLAG</emphasis> (actual
     value is 'serverSocketClass') - specifies the fully qualified class name
     for the custom SocketWrapper implementation to use on the server.</para>
+        
     </section>
     
   </section>