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

docs(pubsublite): recommendation for timeout settings #4389

Merged
merged 2 commits into from Jul 8, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions pubsublite/pscompat/settings.go
Expand Up @@ -73,6 +73,8 @@ type PublishSettings struct {
// details of the last error that occurred while trying to reconnect to
// backends. Note that if the timeout duration is long, ErrOverflow may occur
// first.
//
// It is not recommended to set Timeout below 2 minutes.
Timeout time.Duration

// The maximum number of bytes that the publisher will keep in memory before
Expand Down Expand Up @@ -191,6 +193,8 @@ type ReceiveSettings struct {
// exceeded, the SubscriberClient will terminate with ErrBackendUnavailable
// and details of the last error that occurred while trying to reconnect to
// backends.
//
// It is not recommended to set Timeout below 2 minutes.
Timeout time.Duration

// The topic partition numbers (zero-indexed) to receive messages from.
Expand Down