Skip to content

doc: update keepalive ClientParameters doc about doubling the interval upon GOAWAY #7469

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

Merged
merged 6 commits into from
Aug 20, 2024
Merged

doc: update keepalive ClientParameters doc about doubling the interval upon GOAWAY #7469

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
83d3aae
Update ClientParameters.Time godoc
menghanl Aug 1, 2024
e3c90ce
Update keepalive.go
menghanl Aug 1, 2024
7293606
(including 0)
menghanl Aug 1, 2024
bf2b0ca
Not including 0
menghanl Aug 16, 2024
a0778e4
and something else
menghanl Aug 16, 2024
29dda3d
And another file
menghanl Aug 16, 2024
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
14 changes: 13 additions & 1 deletion keepalive/keepalive.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,19 @@ import (
type ClientParameters struct {
// After a duration of this time if the client doesn't see any activity it
// pings the server to see if the transport is still alive.
// If set below 10s, a minimum value of 10s will be used instead.
// If set below 10s (including 0), a minimum value of 10s will be used
Copy link
Member

@dfawley dfawley Aug 9, 2024

Choose a reason for hiding this comment

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

The "including 0" is probably not needed if we get rid of the comment below as mentioned.

Copy link
Contributor Author

@menghanl menghanl Aug 16, 2024

Choose a reason for hiding this comment

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

Done

// instead.
//
// Note that gRPC servers have a default EnforcementPolicy.MinTime of 5
// minutes (which means the client shouldn't ping more frequently than every
// 5 minutes).
//
// Though not ideal, it's not a strong requirement for Time to be less than
// EnforcementPolicy.MinTime. Time will automatically double if the server
// disconnects due to its enforcement policy.
//
// For more details, see
// https://github.com/grpc/proposal/blob/master/A8-client-side-keepalive.md
Time time.Duration // The current default value is infinity.
Copy link
Member

@dfawley dfawley Aug 9, 2024

Choose a reason for hiding this comment

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

Can you delete this comment, please? Explaining the behavior can be done via the existing text above and in grpc.WithKeepaliveParams (which ideally would be updated as part of this cleanup, if you don't mind, to say something like "Keepalive is disabled by default" or "Keepalive pings are disabled by default").

Copy link
Contributor Author

@menghanl menghanl Aug 16, 2024

Choose a reason for hiding this comment

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

Done

// After having pinged for keepalive check, the client waits for a duration
// of Timeout and if no activity is seen even after that the connection is
Expand Down