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

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

Author: ron.sigal at jboss.com
Date: 2009-08-19 12:17:19 -0400 (Wed, 19 Aug 2009)
New Revision: 5375

Modified:
   remoting2/branches/2.x/docs/guide/en/chap5.xml
Log:
JBREM-1120: Added discussion of "write timeout" facility.

Modified: remoting2/branches/2.x/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.x/docs/guide/en/chap5.xml	2009-08-19 02:05:50 UTC (rev 5374)
+++ remoting2/branches/2.x/docs/guide/en/chap5.xml	2009-08-19 16:17:19 UTC (rev 5375)
@@ -5437,6 +5437,32 @@
           that the acquisition of the network connection might involve multiple
           attempts to connect to the server.
         </para>
+        
+        <section>
+          <title><emphasis role="bold">Write timeouts</emphasis></title>
+          
+          <para>The socket timeout facility offered by the JDK applies only to 
+          <methodname>read</methodname> operations on the socket.  As of
+          release 2.5.2, the socket and bisocket (and also sslsocket and sslbisocket)
+          transports offer a <emphasis role="bold">write timeout</emphasis> facility.
+          When a client or server is configured, in any of the usual ways, with the parameter
+          <code>org.jboss.remoting.transport.socket.SocketWrapper.WRITE_TIMEOUT</code>
+          (actual value "writeTimeout") set to a positive value (in milliseconds), all
+          write operations will time out if they do not complete within the configured
+          period.  When a write operation times out, the socket upon which the write was
+          invoked will be closed, which is likely to result in a 
+          <classname>java.net.SocketException</classname>.</para>
+          
+          <para><emphasis role="bold">Note.</emphasis> A 
+          <classname>SocketException</classname> is considered to be a "retriable"
+          exception, so, if the parameter "numberOfCallRetries" is set to a value
+          greater than 1, an invocation interrupted by a write timeout can be 
+          retried.</para>
+          
+          <para><emphasis role="bold">Note.</emphasis> The write timeout facility
+          applies to writing of both invocations and responses.  It applies to 
+          push callbacks as well.</para>
+        </section>
       </section>
       
       <section>
@@ -6711,5 +6737,15 @@
     
     </section>
     
+    <section>
+    <title>org.jboss.remoting.transport.socket.SocketWrapper</title>
+
+    <para><emphasis role="bold">WRITE_TIMEOUT</emphasis> (actual value
+    is 'writeTimeout') - key for configuring the "write timeout" facility.  If set to
+    a value greater than 0, then a write operation that does not complete within
+    the configured number of milliseconds will be terminated and the socket will
+    be closed. The default value is -1.</para>
+    </section>
+    
   </section>
 </chapter>