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.

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

heartbeat documentation is inconsistent #1386

Closed
cressie176 opened this issue Apr 5, 2022 · 2 comments
Closed

heartbeat documentation is inconsistent #1386

cressie176 opened this issue Apr 5, 2022 · 2 comments

Comments

@cressie176
Copy link
Contributor

The heartbeat documentation contains the following statements

A zero value indicates that a peer suggests disabling heartbeats entirely. To disable heartbeats, both peers have to opt in and use the value of 0

and

Heartbeats can be disabled by setting the timeout interval to 0 on the client side at connection time.

The second statement incorrectly implies that the server heartbeat does not also need to be set to zero in order for the heartbeat to be disabled

@lukebakken
Copy link
Contributor

We would welcome a PR to update the documentation. FWIW, disabling heartbeats is never recommended.

@michaelklishin
Copy link
Member

Closed by #1387 #1388 with minor adjustments from me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants