From 9b1bf6023a9869af744e2fbc03664d41ced37df6 Mon Sep 17 00:00:00 2001
From: Keith Wall <kwall@apache.org>
Date: Wed, 30 Oct 2013 21:38:03 +0000
Subject: QPID-4534: unify client heartbeat system properties/connection url
 options.

* Connection url 'heartbeat' broker-option (and deprecated 'idle_timeout') now understood for all protocols
* System property 'qpid.heartbeat' (and deprecated 'amqj.heartbeat.delay' and 'idle_timeout') now understood for all protocols
* Enhanced heartbeat system tests
* Docbook updates

Original patch from Keith Wall, plus updates from Robbie Gemmell

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1537313 13f79535-47bb-0310-9956-ffa450edef68
---
 qpid/doc/book/src/programming/Programming-In-Apache-Qpid.xml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'qpid/doc/book/src/programming/Programming-In-Apache-Qpid.xml')

diff --git a/qpid/doc/book/src/programming/Programming-In-Apache-Qpid.xml b/qpid/doc/book/src/programming/Programming-In-Apache-Qpid.xml
index e2f6d8756c..d5527850c8 100644
--- a/qpid/doc/book/src/programming/Programming-In-Apache-Qpid.xml
+++ b/qpid/doc/book/src/programming/Programming-In-Apache-Qpid.xml
@@ -3176,7 +3176,8 @@ spout - -content "$(cat rdu.xml | sed -e 's/70/45/')" xml/weather
 		  integer
 	        </entry>
 	        <entry>
-		  frequency of heartbeat messages (in seconds)
+		  Frequency of heartbeat messages (in seconds). A value of 0 disables heartbeating. <para>For compatibility
+                  with old client configuration, option <varname>idle_timeout</varname> (in milliseconds) is also supported.</para>
 	        </entry>
 	      </row>
 	      <row>
@@ -3599,10 +3600,9 @@ spout - -content "$(cat rdu.xml | sed -e 's/70/45/')" xml/weather
 	      <row>
 		<entry>qpid.heartbeat</entry>
 		<entry>int</entry>
-		<entry>120 (secs)</entry>
-		<entry>The heartbeat interval in seconds. Two consective misssed heartbeats will result in the connection timing out.<para>This can also be set per connection using the <link linkend="section-jms-connection-url">Connection URL</link> options.</para></entry>
+		<entry><para>When using the 0-10 protocol, the default is 120 (secs)</para><para>When using protocols 0-8...0-91, the default is the broker-supplied value.</para></entry>
+		<entry>Frequency of heartbeat messages (in seconds). A value of 0 disables heartbeating. <para>Two consective misssed heartbeats will result in the connection timing out.</para><para>This can also be set per connection using the <link linkend="section-jms-connection-url">Connection URL</link> options.</para><para>For compatibility with old client configuration, the synonym <varname>amqj.heartbeat.delay</varname> is supported.</para></entry>
 	      </row>
-
 	      <row>
 		<entry>ignore_setclientID</entry>
 		<entry>boolean</entry>
-- 
cgit v1.2.1