# Packages
No description provided by the author
# Functions
DefaultWatchErrorHandler is the default implementation of WatchErrorHandler.
DeletionHandlingMetaNamespaceKeyFunc checks for DeletedFinalStateUnknown objects before calling MetaNamespaceKeyFunc.
IndexFuncToKeyFuncAdapter adapts an indexFunc to a keyFunc.
ListAll calls appendFn with each value retrieved from store which matches the selector.
ListAllByNamespace used to list items belongs to namespace from Indexer.
MetaNamespaceIndexFunc is a default index function that indexes based on an object's namespace.
MetaNamespaceKeyFunc is a convenient default KeyFunc which knows how to make keys for API objects which implement meta.Interface.
New makes a new Controller from the given Config.
NewCacheMutationDetector creates a new instance for the defaultCacheMutationDetector.
NewDeltaFIFO returns a Queue which can be used to process changes to items.
NewDeltaFIFOWithOptions returns a Queue which can be used to process changes to items.
NewExpirationStore creates and returns a ExpirationCache for a given policy.
NewFakeExpirationStore creates a new instance for the ExpirationCache.
NewFIFO returns a Store which can be used to queue up items to process.
NewFilteredListWatchFromClient creates a new ListWatch from the specified client, resource, namespace, and option modifier.
NewGenericLister creates a new instance for the genericLister.
NewHeap returns a Heap which can be used to queue up items to process.
NewIndexer returns an Indexer implemented simply with a map and a lock.
NewIndexerInformer returns an Indexer and a Controller for populating the index while also providing event notifications.
NewInformer returns a Store and a controller for populating the store while also providing event notifications.
NewIntegerResourceVersionMutationCache returns a MutationCache that understands how to deal with objects that have a resource version that:
- is an integer - increases when updated - is comparable across the same resource in a namespace
Most backends will have these semantics.
NewListWatchFromClient creates a new ListWatch from the specified client, resource, namespace and field selector.
NewNamedReflector same as NewReflector, but with a specified name for logging.
NewNamespaceKeyedIndexerAndReflector creates an Indexer and a Reflector The indexer is configured to key on namespace.
NewReflector creates a new Reflector object which will keep the given store up to date with the server's contents for the given resource.
NewSharedIndexInformer creates a new instance for the listwatcher.
NewSharedInformer creates a new instance for the listwatcher.
NewStore returns a Store implemented simply with a map and a lock.
NewThreadSafeStore creates a new instance of ThreadSafeStore.
NewTTLStore creates and returns a ExpirationCache with a TTLPolicy.
NewUndeltaStore returns an UndeltaStore implemented with a Store.
Pop is helper function for popping from Queue.
SetReflectorMetricsProvider sets the metrics provider.
SplitMetaNamespaceKey returns the namespace and name that MetaNamespaceKeyFunc encoded into key.
WaitForCacheSync waits for caches to populate.
WaitForNamedCacheSync is a wrapper around WaitForCacheSync that generates log messages indicating that the caller identified by name is waiting for syncs, followed by either a successful or failed sync.
# Constants
Change type definition.
Change type definition.
NamespaceIndex is the lookup name for the most comment index function, which is to index by the namespace field.
Replaced is emitted when we encountered watch errors and had to do a relist.
Sync is for synthetic events during a periodic resync.
Change type definition.
# Variables
ErrFIFOClosed used when FIFO is closed.
ErrZeroLengthDeltasObject is returned in a KeyError if a Deltas object with zero length is encountered (should be impossible, but included for completeness).
# Structs
Config contains all the settings for one of these low-level controllers.
DeletedFinalStateUnknown is placed into a DeltaFIFO in the case where an object was deleted but the watch deletion event was missed while disconnected from apiserver.
Delta is a member of Deltas (a list of Delta objects) which in its turn is the type stored by a DeltaFIFO.
DeltaFIFO is like FIFO, but differs in two ways.
DeltaFIFOOptions is the configuration parameters for DeltaFIFO.
ErrRequeue may be returned by a PopProcessFunc to safely requeue the current item.
ExpirationCache implements the store interface 1.
FakeCustomStore lets you define custom functions for store operations.
FakeExpirationPolicy keeps the list for keys which never expires.
FIFO is a Queue in which (a) each accumulator is simply the most recently provided object and (b) the collection of keys to process is a FIFO.
FilteringResourceEventHandler applies the provided filter to all events coming in, ensuring the appropriate nested handler method is invoked.
Heap is a thread-safe producer/consumer queue that implements a heap data structure.
KeyError will be returned any time a KeyFunc gives an error; it includes the object at fault.
ListWatch knows how to list and watch a set of apiserver resources.
Reflector watches a specified resource and causes all changes to be reflected in the given store.
ResourceEventHandlerFuncs is an adaptor to let you easily specify as many or as few of the notification functions as you want while still implementing ResourceEventHandler.
TimestampedEntry is the only type allowed in a ExpirationCache.
TTLPolicy implements a ttl based ExpirationPolicy.
UndeltaStore listens to incremental updates and sends complete state on every change.
# Interfaces
Controller is a low-level controller that is parameterized by a Config and used in sharedIndexInformer.
CounterMetric represents a single numerical value that only ever goes up.
ExpirationPolicy dictates when an object expires.
GaugeMetric represents a single numerical value that can arbitrarily go up and down.
GenericLister is a lister skin on a generic Indexer.
GenericNamespaceLister is a lister skin on a generic Indexer.
Getter interface knows how to access Get method from RESTClient.
Indexer extends Store with multiple indices and restricts each accumulator to simply hold the current object (and be empty after Delete).
A KeyGetter is anything that knows how to get the value stored under a given key.
A KeyLister is anything that knows how to list its keys.
A KeyListerGetter is anything that knows how to list its keys and look up by key.
Lister is any object that knows how to perform an initial list.
ListerWatcher is any object that knows how to perform an initial list and start a watch on a resource.
MetricsProvider generates various metrics used by the reflector.
MutationCache is able to take the result of update operations and stores them in an LRU that can be used to provide a more current view of a requested object.
MutationDetector is able to monitor objects for mutation within a limited window of time.
Queue extends Store with a collection of Store keys to "process".
ResourceEventHandler can handle notifications for events that happen to a resource.
ResourceVersionComparator is able to compare object versions.
ResourceVersionUpdater is an interface that allows store implementation to track the current resource version of the reflector.
SharedIndexInformer provides add and get Indexers ability based on SharedInformer.
SharedInformer provides eventually consistent linkage of its clients to the authoritative state of a given collection of objects.
Store is a generic object storage and processing interface.
SummaryMetric captures individual observations.
ThreadSafeStore is an interface that allows concurrent indexed access to a storage backend.
Watcher is any object that knows how to start a watch on a resource.
# Type aliases
AppendFunc is used to add a matching item to whatever list the caller is using.
Deltas is a list of one or more 'Delta's to an individual object.
DeltaType is the type of a change (addition, deletion, etc).
ExplicitKey can be passed to MetaNamespaceKeyFunc if you have the key for the object but not the object itself.
Index maps the indexed value to a set of keys in the store that match on that value.
Indexers maps a name to a IndexFunc.
IndexFunc knows how to compute the set of indexed values for an object.
Indices maps a name to an Index.
InformerSynced is a function that can be used to determine if an informer has synced.
KeyFunc knows how to make a key from an object.
LessFunc is used to compare two objects in the heap.
ListFunc knows how to list resources.
PopProcessFunc is passed to Pop() method of Queue interface.
ProcessFunc processes a single object.
ShouldResyncFunc is a type of function that indicates if a reflector should perform a resync or not.
The WatchErrorHandler is called whenever ListAndWatch drops the connection with an error.
WatchFunc knows how to watch resources.