Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typo #90

Merged
merged 1 commit into from
Feb 16, 2016
Merged

Fix typo #90

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DOCUMENTATION.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}``
* ``hearbeat`` Default None (disabled). If 0, broker assigned. If >0, negotiated with broker.
* ``heartbeat`` Default None (disabled). If 0, broker assigned. If >0, negotiated with broker.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@awestendorf: I just noticed that the description doesn't match the implementation. The implementation appears to be that if user passed heartbeat=None, then the heartbeat value is broker-assigned; if user passed heartbeat=0, then heartbeats would be disabled. The description is the reverse of what actually happens.

        if self.connection._heartbeat is None:
            self.connection._heartbeat = method_frame.args.read_short()

I filed this as issue #91

* ``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".
Expand Down