Skip to content

Commit 1a049e9

Browse files
Reword comments on new ClientState and watch methods
Signed-off-by: Valerian Roche <[email protected]>
1 parent 8289c7a commit 1a049e9

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

pkg/cache/v3/cache.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ type ClientState interface {
4848
GetKnownResources() map[string]string
4949

5050
// GetSubscribedResources returns the list of resources currently subscribed to by the client for the type.
51-
// For delta it keeps track across requests
52-
// For sotw it is a normalized view of the request resources
51+
// For delta it keeps track of subscription updates across requests
52+
// For sotw it is a normalized view of the last request resources
5353
GetSubscribedResources() map[string]struct{}
5454

5555
// IsWildcard returns whether the client has a wildcard watch.

pkg/cache/v3/status.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,10 @@ type DeltaResponseWatch struct {
101101
clientState ClientState
102102
}
103103

104-
// WatchesResources returns whether at least one of the resource provided is currently watch by the stream
105-
// It is currently only applicable to delta-xds
106-
// If the request is wildcard, it will always return true
107-
// Otherwise it will compare the provided resources to the list of resources currently subscribed
104+
// WatchesResources returns whether at least one of the resources provided is currently being watched by the stream.
105+
// It is currently only applicable to delta-xds.
106+
// If the request is wildcard, it will always return true,
107+
// otherwise it will compare the provided resources to the list of resources currently subscribed
108108
func (w *DeltaResponseWatch) WatchesResources(resourceNames map[string]struct{}) bool {
109109
if w.clientState.IsWildcard() {
110110
return true

0 commit comments

Comments
 (0)