Skip to content

Commit eca4a6b

Browse files
Clarify that ConnectionFactory#setRequestedHeartbeat sets a timeout value, not communication interval
Also, link to our upcoming guide.
1 parent b04d8ff commit eca4a6b

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/com/rabbitmq/client/ConnectionFactory.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,8 +346,9 @@ public int getShutdownTimeout() {
346346
}
347347

348348
/**
349-
* Set the requested heartbeat.
350-
* @param requestedHeartbeat the initially requested heartbeat interval, in seconds; zero for none
349+
* Set the requested heartbeat timeout. Heartbeat frames will be sent at about 1/2 the timeout interval.
350+
* @param requestedHeartbeat the initially requested heartbeat timeout, in seconds; zero for none
351+
* @see <a href="http://rabbitmq.com/heartbeats.html">RabbitMQ Heartbeats Guide</a>
351352
*/
352353
public void setRequestedHeartbeat(int requestedHeartbeat) {
353354
this.requestedHeartbeat = requestedHeartbeat;

0 commit comments

Comments
 (0)