From c40f2ae4f826e53398aafbc6592153a56ec05c3a Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Wed, 17 Feb 2016 15:05:01 -0500 Subject: [PATCH] Correct heartbeat documentation to reflect the code Refs #90 Closes #91 --- DOCUMENTATION.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DOCUMENTATION.rst b/DOCUMENTATION.rst index 5cdfbf8..09f75d8 100644 --- a/DOCUMENTATION.rst +++ b/DOCUMENTATION.rst @@ -331,7 +331,7 @@ The constructor takes many keyword arguments that will affect its behavior. * ``vhost`` Default "/". * ``connect_timeout`` Default 5 seconds. Time before socket connection fails. * ``sock_opts`` Default None. Recommend at least ``{(socket.IPPROTO_TCP, socket.TCP_NODELAY) : 1}`` -* ``heartbeat`` Default None (disabled). If 0, broker assigned. If >0, negotiated with broker. +* ``heartbeat`` Default None (broker assigned). If ``heartbeat == 0``, disables heartbeats. If ``heartbeat > 0``, negotiated with broker. * ``open_cb`` Default None. A no-arg method to be called after connection fully negotiated and pending frames written. * ``close_cb`` Default None. A no-arg method to be called when connection closes due to protocol handshake or transport closure. * ``login_method`` Defaults to "AMQPLAIN".