Merge pull request rabbitmq#28 from rabbitmq/bug26607

Simon MacMullen · Simon MacMullen · commit af9316a2408a · 2015-02-20T12:05:38.000Z
Clarify that ConnectionFactory#setRequestedHeartbeat sets a timeout
diff --git a/src/com/rabbitmq/client/ConnectionFactory.java b/src/com/rabbitmq/client/ConnectionFactory.java
@@ -343,8 +343,9 @@ public int getShutdownTimeout() {
     }
 
     /**
-     * Set the requested heartbeat.
-     * @param requestedHeartbeat the initially requested heartbeat interval, in seconds; zero for none
+     * Set the requested heartbeat timeout. Heartbeat frames will be sent at about 1/2 the timeout interval.
+     * @param requestedHeartbeat the initially requested heartbeat timeout, in seconds; zero for none
+     * @see <a href="http://rabbitmq.com/heartbeats.html">RabbitMQ Heartbeats Guide</a>
      */
     public void setRequestedHeartbeat(int requestedHeartbeat) {
         this.requestedHeartbeat = requestedHeartbeat;
