[QPID-4534] Unify client side heartbeat system properties/broker url options

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.25
• Component/s: Java Documentation, JMS AMQP 0-x
• Assignee: Keith Wall
• Reporter: Keith Wall
• Created: 13/Jan/13 17:11
• Updated: 02/Oct/19 19:22
• Resolved: 30/Oct/13 22:20

Description

The heartbeat controls/defaults offered by the 0-10 Java client are different and to those used by the 0-8..0-9-1. This has the potential to confuse the end-user and makes clear documentation more difficult.

The current situation looks like this:

The 0-10 codepath defaults heart-beating to enabled with a period of 120s. It may be configured on the client side by either:

• broker url option ?heartbeat=... (value in secs)
• system properties qpid.heartbeat (value in secs), amqj.heartbeat.delay (secs), idle_timeout (ms). The latter two are considered deprecated.

The 0-8..0-9-1 codepath defaults heart-beating to disabled. It may be enabled on the client side using the system property amqj.heartbeat.delay.
In the Java Broker's implementation of 0-8..0-9-1 allows heartbeating to be enabled from the server side, by a mechanism where the server proposes a heartbeat value to the client, and the client can either accept the value or put forward its own. The client does not understand the broker url option 'heartbeat' nor the newer system property qpid.heartbeat.

The Programming in Apache Qpid docbook reflects the 0-10 behaviour and makes no mention to the differences in the other protocols.

The intention is to change the code as follows:

1. make both code paths understand the qpid.heartbeat system property. amqj.heartbeat.delay will continue to be supported as deprecated.
2. make the broker url option heartbeat=... will be understood by both code paths
3. update docbook