github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-11 13:02:14 +00:00
Code Issues Projects Releases Wiki Activity

Fix comment on SharedInformer.Run

Browse Source 
The old wording suggested that `Run` only gets the controller started.
Changed the wording to make it clear that `Run` only returns after the
controller is stopped.
This commit is contained in:
Mike Spreitzer 2019-05-04 23:27:42 -04:00
parent c516bb51e3
commit fad9dec758
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
staging/src/k8s.io/client-go/tools/cache/shared_informer.go vendored
View File

@ -53,7 +53,8 @@ type SharedInformer interface {
GetStore() Store GetStore() Store
// GetController gives back a synthetic interface that "votes" to start the informer // GetController gives back a synthetic interface that "votes" to start the informer
GetController() Controller GetController() Controller
// Run starts the shared informer, which will be stopped when stopCh is closed. // Run starts and runs the shared informer, returning after it stops.
// The informer will be stopped when stopCh is closed.
Run(stopCh <-chan struct{}) Run(stopCh <-chan struct{})
// HasSynced returns true if the shared informer's store has synced. // HasSynced returns true if the shared informer's store has synced.
HasSynced() bool HasSynced() bool