From 21cb39b8925c773bb9621f86257e9094815bbeca Mon Sep 17 00:00:00 2001
From: Gary Russell <grussell@vmware.com>
Date: Tue, 10 May 2011 19:21:06 -0400
Subject: [PATCH] INT-1898 Document 1 Second Timeout for Inbound Gateways

---
 docs/src/reference/docbook/gateway.xml | 15 ++++++++++++++-
 docs/src/reference/docbook/ip.xml      |  6 ++++--
 2 files changed, 18 insertions(+), 3 deletions(-)

diff --git a/docs/src/reference/docbook/gateway.xml b/docs/src/reference/docbook/gateway.xml
index 84c6c28017..9ae34a21b8 100644
--- a/docs/src/reference/docbook/gateway.xml
+++ b/docs/src/reference/docbook/gateway.xml
@@ -277,7 +277,7 @@ For a more detailed example, please refer to the <emphasis>async-gateway</emphas
     </para>
     <para>
       <important>
-    It is also important to understand that by default <emphasis>reply-timeout</emphasis> is unbounded which means that
+    It is also important to understand that by default <emphasis>reply-timeout</emphasis> is unbounded* which means that
     if not explicitly set there are several scenarios (described above) where your Gateway method invocation might
     hang indefinitely. So, make sure you analyze your flow and if there is even a remote possibility of one of these
     scenarios to occur, set the <emphasis>reply-timeout</emphasis> attribute to a 'safe' value or, even better,
@@ -294,6 +294,19 @@ For a more detailed example, please refer to the <emphasis>async-gateway</emphas
     you can set the <emphasis>throw-exception-on-rejection</emphasis> attribute. In both of these cases, the resulting flow will
     behave like that containing a service-activator with the 'requires-reply' attribute. In other words, it will help to ensure
     a timely response from the Gateway method invocation.
+    </para>
+    <para>
+        <note>
+            <para>
+                * <emphasis>reply-timeout</emphasis> is unbounded for <emphasis>&lt;gateway/&gt;</emphasis>
+                elements (created by the GatewayProxyFactoryBean). Inbound gateways for external integration
+                (ws, http, etc.) share many characteristics and attributes with these gateways. However, 
+                for those inbound gateways, the default <emphasis>reply-timeout</emphasis> is 1000
+                milliseconds (1 second). If a downstream async handoff is made to another thread, you may need to
+                increase this attribute to allow enough time for the flow to complete before the
+                gateway times out.
+            </para>
+        </note>
     </para>
       </important>
     </para>
diff --git a/docs/src/reference/docbook/ip.xml b/docs/src/reference/docbook/ip.xml
index 8a8dbf856d..e22bede37c 100644
--- a/docs/src/reference/docbook/ip.xml
+++ b/docs/src/reference/docbook/ip.xml
@@ -1152,7 +1152,8 @@
             <row>
               <entry>reply-timeout</entry>
               <entry></entry>
-              <entry>The time in milliseconds for which the gateway will wait for a reply.</entry>
+              <entry>The time in milliseconds for which the gateway will wait for a reply.
+                     Default 1000 (1 second).</entry>
             </row>
             <row>
               <entry>error-channel</entry>
@@ -1201,7 +1202,8 @@
             <row>
               <entry>reply-timeout</entry>
               <entry></entry>
-              <entry>The time in milliseconds for which the gateway will wait for a reply.</entry>
+              <entry>The time in milliseconds for which the gateway will wait for a reply.
+                     Default: 10000 (10 seconds).</entry>
             </row>
             <row>
               <entry>request-timeout</entry>