Documentation ¶
Index ¶
- Constants
- func NewListerWatcher(storage storage.Interface, resourcePrefix string, ...) cache.ListerWatcher
- type Cacher
- func (c *Cacher) Count(pathPrefix string) (int64, error)
- func (c *Cacher) Create(ctx context.Context, key string, obj, out runtime.Object, ttl uint64) error
- func (c *Cacher) Delete(ctx context.Context, key string, out runtime.Object, ...) error
- func (c *Cacher) Get(ctx context.Context, key string, opts storage.GetOptions, ...) error
- func (c *Cacher) GetList(ctx context.Context, key string, opts storage.ListOptions, ...) error
- func (c *Cacher) GuaranteedUpdate(ctx context.Context, key string, destination runtime.Object, ...) error
- func (c *Cacher) LastSyncResourceVersion() (uint64, error)
- func (c *Cacher) RequestWatchProgress(ctx context.Context) error
- func (c *Cacher) Stop()
- func (c *Cacher) Versioner() storage.Versioner
- func (c *Cacher) Wait(ctx context.Context) error
- func (c *Cacher) Watch(ctx context.Context, key string, opts storage.ListOptions) (watch.Interface, error)
- type Config
- type TickerFactory
- type WatchProgressRequester
Constants ¶
const ( Pending status = iota Ready Stopped )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Cacher ¶
Cacher is responsible for serving WATCH and LIST requests for a given resource from its internal cache and updating its cache in the background based on the underlying storage contents. Cacher implements storage.Interface (although most of the calls are just delegated to the underlying storage).
func NewCacherFromConfig ¶
NewCacherFromConfig creates a new Cacher responsible for servicing WATCH and LIST requests from its internal cache and updating its cache in the background based on the given configuration.
func (*Cacher) Delete ¶
func (c *Cacher) Delete( ctx context.Context, key string, out runtime.Object, preconditions *storage.Preconditions, validateDeletion storage.ValidateObjectFunc, _ runtime.Object) error
Delete implements storage.Interface.
func (*Cacher) Get ¶
func (c *Cacher) Get(ctx context.Context, key string, opts storage.GetOptions, objPtr runtime.Object) error
Get implements storage.Interface.
func (*Cacher) GetList ¶ added in v0.24.0
func (c *Cacher) GetList(ctx context.Context, key string, opts storage.ListOptions, listObj runtime.Object) error
GetList implements storage.Interface
func (*Cacher) GuaranteedUpdate ¶
func (c *Cacher) GuaranteedUpdate( ctx context.Context, key string, destination runtime.Object, ignoreNotFound bool, preconditions *storage.Preconditions, tryUpdate storage.UpdateFunc, _ runtime.Object) error
GuaranteedUpdate implements storage.Interface.
func (*Cacher) LastSyncResourceVersion ¶
LastSyncResourceVersion returns resource version to which the underlying cache is synced.
func (*Cacher) RequestWatchProgress ¶ added in v0.28.0
type Config ¶
type Config struct { // An underlying storage.Interface. Storage storage.Interface // An underlying storage.Versioner. Versioner storage.Versioner // The GroupResource the cacher is caching. Used for disambiguating *unstructured.Unstructured (CRDs) in logging // and metrics. GroupResource schema.GroupResource // The Cache will be caching objects of a given Type and assumes that they // are all stored under ResourcePrefix directory in the underlying database. ResourcePrefix string // KeyFunc is used to get a key in the underlying storage for a given object. KeyFunc func(runtime.Object) (string, error) // GetAttrsFunc is used to get object labels, fields GetAttrsFunc func(runtime.Object) (label labels.Set, field fields.Set, err error) // IndexerFuncs is used for optimizing amount of watchers that // needs to process an incoming event. IndexerFuncs storage.IndexerFuncs // Indexers is used to accelerate the list operation, falls back to regular list // operation if no indexer found. Indexers *cache.Indexers // NewFunc is a function that creates new empty object storing a object of type Type. NewFunc func() runtime.Object // NewList is a function that creates new empty object storing a list of // objects of type Type. NewListFunc func() runtime.Object Codec runtime.Codec Clock clock.WithTicker }
Config contains the configuration for a given Cache.