mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-14 18:30:21 +00:00
54 lines
2.0 KiB
Go
54 lines
2.0 KiB
Go
/*
|
|
Copyright 2018 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package dynamicinformer
|
|
|
|
import (
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/runtime/schema"
|
|
"k8s.io/client-go/informers"
|
|
)
|
|
|
|
// DynamicSharedInformerFactory provides access to a shared informer and lister for dynamic client
|
|
type DynamicSharedInformerFactory interface {
|
|
// Start initializes all requested informers. They are handled in goroutines
|
|
// which run until the stop channel gets closed.
|
|
Start(stopCh <-chan struct{})
|
|
|
|
// ForResource gives generic access to a shared informer of the matching type.
|
|
ForResource(gvr schema.GroupVersionResource) informers.GenericInformer
|
|
|
|
// WaitForCacheSync blocks until all started informers' caches were synced
|
|
// or the stop channel gets closed.
|
|
WaitForCacheSync(stopCh <-chan struct{}) map[schema.GroupVersionResource]bool
|
|
|
|
// Shutdown marks a factory as shutting down. At that point no new
|
|
// informers can be started anymore and Start will return without
|
|
// doing anything.
|
|
//
|
|
// In addition, Shutdown blocks until all goroutines have terminated. For that
|
|
// to happen, the close channel(s) that they were started with must be closed,
|
|
// either before Shutdown gets called or while it is waiting.
|
|
//
|
|
// Shutdown may be called multiple times, even concurrently. All such calls will
|
|
// block until all goroutines have terminated.
|
|
Shutdown()
|
|
}
|
|
|
|
// TweakListOptionsFunc defines the signature of a helper function
|
|
// that wants to provide more listing options to API
|
|
type TweakListOptionsFunc func(*metav1.ListOptions)
|