Browse Source

Merge pull request #8106 from heyitsanthony/clarify-watch-comment

clientv3: clarify Watch close conditions
Anthony Romano 8 years ago
parent
commit
1f206c027a
1 changed files with 3 additions and 4 deletions
  1. 3 4
      clientv3/watch.go

+ 3 - 4
clientv3/watch.go

@@ -40,10 +40,9 @@ type WatchChan <-chan WatchResponse
 
 type Watcher interface {
 	// Watch watches on a key or prefix. The watched events will be returned
-	// through the returned channel.
-	// If the watch is slow or the required rev is compacted, the watch request
-	// might be canceled from the server-side and the chan will be closed.
-	// 'opts' can be: 'WithRev' and/or 'WithPrefix'.
+	// through the returned channel. If revisions waiting to be sent over the
+	// watch are compacted, then the watch will be canceled by the server, the
+	// client will post a compacted error watch response, and the channel will close.
 	Watch(ctx context.Context, key string, opts ...OpOption) WatchChan
 
 	// Close closes the watcher and cancels all watch requests.