Skip to content

Commit

Permalink
Merge pull request #9115 from gyuho/doc-watch
Browse files Browse the repository at this point in the history
clientv3: document possible memory pile-up in Watch
  • Loading branch information
spzala authored Jan 11, 2018
2 parents a86e1ff + 31c2d4b commit e16abdf
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions clientv3/watch.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ type Watcher interface {
// client will post a compacted error watch response, and the channel will close.
// If the context "ctx" is canceled or timed out, returned "WatchChan" is closed,
// and "WatchResponse" from this closed channel has zero events and nil "Err()".
// The context "ctx" MUST be canceled, as soon as watcher is no longer being used,
// to release the associated resources.
// If the context is "context.Background/TODO", returned "WatchChan" will not be closed
// and wait until events happen, except when server returns a non-recoverable error.
// For example, when context passed with "WithRequireLeader" and the connected server
Expand Down

0 comments on commit e16abdf

Please sign in to comment.