mirror of
https://github.com/kubernetes/sample-controller.git
synced 2025-02-13 18:22:51 +08:00
a7ac24a6d0
Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. #50102 Task 2: Add UntilWithSync **What this PR does / why we need it**: This is a split off from https://github.com/kubernetes/kubernetes/pull/50102 to go in smaller pieces. Introduces UntilWithSync based on informer. **Needs https://github.com/kubernetes/kubernetes/pull/66906 first** /hold **Release note**: ```release-note NONE ``` /priority important-soon /kind bug (bug after the main PR which is this split from) Kubernetes-commit: c4f355a2ad9692f5459541d4e4d94fcbc5f7d946
113 lines
4.0 KiB
Go
113 lines
4.0 KiB
Go
/*
|
|
Copyright 2015 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 cache
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/fields"
|
|
"k8s.io/apimachinery/pkg/runtime"
|
|
"k8s.io/apimachinery/pkg/watch"
|
|
restclient "k8s.io/client-go/rest"
|
|
"k8s.io/client-go/tools/pager"
|
|
)
|
|
|
|
// ListerWatcher is any object that knows how to perform an initial list and start a watch on a resource.
|
|
type ListerWatcher interface {
|
|
// List should return a list type object; the Items field will be extracted, and the
|
|
// ResourceVersion field will be used to start the watch in the right place.
|
|
List(options metav1.ListOptions) (runtime.Object, error)
|
|
// Watch should begin a watch at the specified version.
|
|
Watch(options metav1.ListOptions) (watch.Interface, error)
|
|
}
|
|
|
|
// ListFunc knows how to list resources
|
|
type ListFunc func(options metav1.ListOptions) (runtime.Object, error)
|
|
|
|
// WatchFunc knows how to watch resources
|
|
type WatchFunc func(options metav1.ListOptions) (watch.Interface, error)
|
|
|
|
// ListWatch knows how to list and watch a set of apiserver resources. It satisfies the ListerWatcher interface.
|
|
// It is a convenience function for users of NewReflector, etc.
|
|
// ListFunc and WatchFunc must not be nil
|
|
type ListWatch struct {
|
|
ListFunc ListFunc
|
|
WatchFunc WatchFunc
|
|
// DisableChunking requests no chunking for this list watcher.
|
|
DisableChunking bool
|
|
}
|
|
|
|
// Getter interface knows how to access Get method from RESTClient.
|
|
type Getter interface {
|
|
Get() *restclient.Request
|
|
}
|
|
|
|
// NewListWatchFromClient creates a new ListWatch from the specified client, resource, namespace and field selector.
|
|
func NewListWatchFromClient(c Getter, resource string, namespace string, fieldSelector fields.Selector) *ListWatch {
|
|
optionsModifier := func(options *metav1.ListOptions) {
|
|
options.FieldSelector = fieldSelector.String()
|
|
}
|
|
return NewFilteredListWatchFromClient(c, resource, namespace, optionsModifier)
|
|
}
|
|
|
|
// NewFilteredListWatchFromClient creates a new ListWatch from the specified client, resource, namespace, and option modifier.
|
|
// Option modifier is a function takes a ListOptions and modifies the consumed ListOptions. Provide customized modifier function
|
|
// to apply modification to ListOptions with a field selector, a label selector, or any other desired options.
|
|
func NewFilteredListWatchFromClient(c Getter, resource string, namespace string, optionsModifier func(options *metav1.ListOptions)) *ListWatch {
|
|
listFunc := func(options metav1.ListOptions) (runtime.Object, error) {
|
|
optionsModifier(&options)
|
|
return c.Get().
|
|
Namespace(namespace).
|
|
Resource(resource).
|
|
VersionedParams(&options, metav1.ParameterCodec).
|
|
Do().
|
|
Get()
|
|
}
|
|
watchFunc := func(options metav1.ListOptions) (watch.Interface, error) {
|
|
options.Watch = true
|
|
optionsModifier(&options)
|
|
return c.Get().
|
|
Namespace(namespace).
|
|
Resource(resource).
|
|
VersionedParams(&options, metav1.ParameterCodec).
|
|
Watch()
|
|
}
|
|
return &ListWatch{ListFunc: listFunc, WatchFunc: watchFunc}
|
|
}
|
|
|
|
func timeoutFromListOptions(options metav1.ListOptions) time.Duration {
|
|
if options.TimeoutSeconds != nil {
|
|
return time.Duration(*options.TimeoutSeconds) * time.Second
|
|
}
|
|
return 0
|
|
}
|
|
|
|
// List a set of apiserver resources
|
|
func (lw *ListWatch) List(options metav1.ListOptions) (runtime.Object, error) {
|
|
if !lw.DisableChunking {
|
|
return pager.New(pager.SimplePageFunc(lw.ListFunc)).List(context.TODO(), options)
|
|
}
|
|
return lw.ListFunc(options)
|
|
}
|
|
|
|
// Watch a set of apiserver resources
|
|
func (lw *ListWatch) Watch(options metav1.ListOptions) (watch.Interface, error) {
|
|
return lw.WatchFunc(options)
|
|
}
|