Skip to content

Commit

Permalink
docs(pubsublite): recommendation for timeout settings (#4389)
Browse files Browse the repository at this point in the history
  • Loading branch information
tmdiep committed Jul 8, 2021
1 parent 6235a8a commit 9c8aa5a
Showing 1 changed file with 4 additions and 0 deletions.
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

0 comments on commit 9c8aa5a

Please sign in to comment.