From jboss-remoting-commits at lists.jboss.org Wed Aug 19 12:23:39 2009
Content-Type: multipart/mixed; boundary="===============3289301558006949910=="
MIME-Version: 1.0
From: jboss-remoting-commits at lists.jboss.org
To: jboss-remoting-commits at lists.jboss.org
Subject: [jboss-remoting-commits] JBoss Remoting SVN: r5376 -
 remoting2/branches/2.2/docs/guide/en.
Date: Wed, 19 Aug 2009 12:23:39 -0400
Message-ID: <200908191623.n7JGNdHk014952@svn01.web.mwc.hst.phx2.redhat.com>

--===============3289301558006949910==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: ron.sigal(a)jboss.com
Date: 2009-08-19 12:23:38 -0400 (Wed, 19 Aug 2009)
New Revision: 5376

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

Modified: remoting2/branches/2.2/docs/guide/en/chap5.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- remoting2/branches/2.2/docs/guide/en/chap5.xml	2009-08-19 16:17:19 UTC =
(rev 5375)
+++ remoting2/branches/2.2/docs/guide/en/chap5.xml	2009-08-19 16:23:38 UTC =
(rev 5376)
@@ -5872,6 +5872,33 @@
           that the acquisition of the network connection might involve mul=
tiple
           attempts to connect to the server.
         </para>
+        =

+        <section>
+          <title><emphasis role=3D"bold">Write timeouts</emphasis></title>
+          =

+          <para>The socket timeout facility offered by the JDK applies onl=
y to =

+          <methodname>read</methodname> operations on the socket.  As of
+          release 2.5.2, the socket and bisocket (and also sslsocket and s=
slbisocket)
+          transports offer a <emphasis role=3D"bold">write timeout</emphas=
is> 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_TI=
MEOUT</code>
+          (actual value "writeTimeout") set to a positive value (in millis=
econds), all
+          write operations will time out if they do not complete within th=
e 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=3D"bold">Note.</emphasis> A =

+          <classname>SocketException</classname> is considered to be a "re=
triable"
+          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=3D"bold">Note.</emphasis> The write timeout=
 facility
+          applies to writing of both invocations and responses.  It applie=
s to =

+          push callbacks as well.</para>
+        </section>
+        =

       </section>
       =

       <section>
@@ -6742,5 +6769,14 @@
     <para><emphasis role=3D"bold">SERVER_SOCKET_CLASS_FLAG</emphasis> (act=
ual
     value is 'serverSocketClass') - specifies the fully qualified class na=
me
     for the custom SocketWrapper implementation to use on the server.</par=
a>
-  </section>
+  =

+    <bridgehead>org.jboss.remoting.transport.socket.SocketWrapper</bridgeh=
ead>
+
+    <para><emphasis role=3D"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 socke=
t will
+    be closed. The default value is -1.</para>
+
+    </section>  =

 </chapter>
\ No newline at end of file


--===============3289301558006949910==--