github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-01 07:47:56 +00:00
Code Issues Projects Releases Wiki Activity

pkg/storage: docs on watch 0 behavior

Browse Source
This commit is contained in:
Hongchao Deng 2016-11-14 21:35:56 -08:00
parent 34db128af9
commit 62c0e5abc3
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pkg/storage/interfaces.go
View File

@ -112,6 +112,8 @@ type Interface interface {
// resourceVersion may be used to specify what version to begin watching, // resourceVersion may be used to specify what version to begin watching,
// which should be the current resourceVersion, and no longer rv+1 // which should be the current resourceVersion, and no longer rv+1
// (e.g. reconnecting without missing any updates). // (e.g. reconnecting without missing any updates).
// If resource version is "0", this interface will get current object at given key
// and send it in an "ADDED" event, before watch starts.
Watch(ctx context.Context, key string, resourceVersion string, p SelectionPredicate) (watch.Interface, error) Watch(ctx context.Context, key string, resourceVersion string, p SelectionPredicate) (watch.Interface, error)
// WatchList begins watching the specified key's items. Items are decoded into API // WatchList begins watching the specified key's items. Items are decoded into API
@ -119,6 +121,8 @@ type Interface interface {
// resourceVersion may be used to specify what version to begin watching, // resourceVersion may be used to specify what version to begin watching,
// which should be the current resourceVersion, and no longer rv+1 // which should be the current resourceVersion, and no longer rv+1
// (e.g. reconnecting without missing any updates). // (e.g. reconnecting without missing any updates).
// If resource version is "0", this interface will list current objects directory defined by key
// and send them in "ADDED" events, before watch starts.
WatchList(ctx context.Context, key string, resourceVersion string, p SelectionPredicate) (watch.Interface, error) WatchList(ctx context.Context, key string, resourceVersion string, p SelectionPredicate) (watch.Interface, error)
// Get unmarshals json found at key into objPtr. On a not found error, will either // Get unmarshals json found at key into objPtr. On a not found error, will either