fileinformer

package

v0.9.1 Latest Latest Go to latest Published: Aug 18, 2023 License: Apache-2.0 Imports: 11 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/authzed/controller-idioms

Links

Open Source Insights

Documentation ¶

Overview ¶

Package fileinformer implements a kube-style Informer and InformerFactory that can be used to watch files instead of kube apis.

Index ¶

Variables
type Factory
- func NewFileInformerFactory(log logr.Logger) (*Factory, error)
type FileInformer
- func NewFileInformer(log logr.Logger, watcher *fsnotify.Watcher, gvr schema.GroupVersionResource) (*FileInformer, error)
- func (f *FileInformer) Informer() cache.SharedIndexInformer
- func (f *FileInformer) Lister() cache.GenericLister
type FileSharedIndexInformer
- func NewFileSharedIndexInformer(log logr.Logger, fileName string, watcher *fsnotify.Watcher, ...) *FileSharedIndexInformer

Constants ¶

This section is empty.

Variables ¶

View Source

var FileGroupVersion = schema.GroupVersion{
	Group:   "//LocalFile",
	Version: "v1",
}

FileGroupVersion is a sythetic GroupVersion that the informers use.

Functions ¶

This section is empty.

Types ¶

type Factory ¶

type Factory struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Factory implements dynamicinformer.DynamicSharedInformerFactory, but for starting and managing FileInformers.

func NewFileInformerFactory ¶

func NewFileInformerFactory(log logr.Logger) (*Factory, error)

NewFileInformerFactory creates a new Factory.

func (*Factory) ForResource ¶

func (f *Factory) ForResource(gvr schema.GroupVersionResource) informers.GenericInformer

ForResource will create an informer for a specific file.

func (*Factory) Shutdown ¶ added in v0.8.0

func (f *Factory) Shutdown()

Shutdown stops watching the files defined by the informers.

func (*Factory) Start ¶

func (f *Factory) Start(stopCh <-chan struct{})

Start starts watching the files defined by the informers.

func (*Factory) WaitForCacheSync ¶

func (f *Factory) WaitForCacheSync(stopCh <-chan struct{}) map[schema.GroupVersionResource]bool

WaitForCacheSync waits until all files in the informers have been synced once.

type FileInformer ¶

type FileInformer struct {
	// contains filtered or unexported fields
}

FileInformer is an informer that watches files instead of the kube api.

func NewFileInformer ¶

func NewFileInformer(log logr.Logger, watcher *fsnotify.Watcher, gvr schema.GroupVersionResource) (*FileInformer, error)

NewFileInformer returns a new FileInformer.

func (*FileInformer) Informer ¶

func (f *FileInformer) Informer() cache.SharedIndexInformer

func (*FileInformer) Lister ¶

func (f *FileInformer) Lister() cache.GenericLister

type FileSharedIndexInformer ¶

type FileSharedIndexInformer struct {
	sync.Once
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewFileSharedIndexInformer ¶

func NewFileSharedIndexInformer(log logr.Logger, fileName string, watcher *fsnotify.Watcher, defaultEventHandlerResyncPeriod time.Duration) *FileSharedIndexInformer

NewFileSharedIndexInformer creates a new informer watching the file Note that currently all event handlers share the default resync period.

func (*FileSharedIndexInformer) AddEventHandler ¶

func (f *FileSharedIndexInformer) AddEventHandler(handler cache.ResourceEventHandler) (cache.ResourceEventHandlerRegistration, error)

func (*FileSharedIndexInformer) AddEventHandlerWithResyncPeriod ¶

func (f *FileSharedIndexInformer) AddEventHandlerWithResyncPeriod(handler cache.ResourceEventHandler, _ time.Duration) (cache.ResourceEventHandlerRegistration, error)

func (*FileSharedIndexInformer) AddIndexers ¶

func (f *FileSharedIndexInformer) AddIndexers(_ cache.Indexers) error

func (*FileSharedIndexInformer) GetController ¶

func (f *FileSharedIndexInformer) GetController() cache.Controller

func (*FileSharedIndexInformer) GetIndexer ¶

func (f *FileSharedIndexInformer) GetIndexer() cache.Indexer

func (*FileSharedIndexInformer) GetStore ¶

func (f *FileSharedIndexInformer) GetStore() cache.Store

func (*FileSharedIndexInformer) HasSynced ¶

func (f *FileSharedIndexInformer) HasSynced() bool

func (*FileSharedIndexInformer) IsStopped ¶ added in v0.6.0

func (f *FileSharedIndexInformer) IsStopped() bool

func (*FileSharedIndexInformer) LastSyncResourceVersion ¶

func (f *FileSharedIndexInformer) LastSyncResourceVersion() string

func (*FileSharedIndexInformer) RemoveEventHandler ¶ added in v0.6.0

func (*FileSharedIndexInformer) RemoveEventHandler(_ cache.ResourceEventHandlerRegistration) error

RemoveEventHandler implements cache.SharedInformer

func (*FileSharedIndexInformer) Run ¶

func (f *FileSharedIndexInformer) Run(stopCh <-chan struct{})

func (*FileSharedIndexInformer) SetTransform ¶

func (f *FileSharedIndexInformer) SetTransform(_ cache.TransformFunc) error

func (*FileSharedIndexInformer) SetWatchErrorHandler ¶

func (f *FileSharedIndexInformer) SetWatchErrorHandler(_ cache.WatchErrorHandler) error

Source Files ¶

View all Source files

file_informer.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL