watcher

Documentation

Overview

Package watcher provides functions used by all watchers.

Index

• type AggregateConfig
• type WantsAggregateConfig
• type WantsAggregateStore
• type WantsStore
• type WatcherInitializer
  • func NewInitializer(aggregate *AggregateConfig) *WatcherInitializer
  • func (w *WatcherInitializer) Initialize(wc registry.Watcher)

Types

type AggregateConfig

type AggregateConfig struct {
	Minio minio.IMinio
	Store store.IStore
	// The purpose of nightwatch is to handle asynchronous tasks on the onex platform
	// in a unified manner, so a store aggregation type is needed here.
	AggregateStore aggregatestore.Interface

	// Client is the client for onex-apiserver.
	Client clientset.Interface

	// Then maximum concurrency event of user watcher.
	UserWatcherMaxWorkers int64
}

AggregateConfig aggregates the configurations of all watchers and serves as a configuration aggregator.

type WantsAggregateConfig

type WantsAggregateConfig interface {
	registry.Watcher
	SetAggregateConfig(config *AggregateConfig)
}

WantsAggregateConfig defines a function which sets AggregateConfig for watcher plugins that need it.

type WantsAggregateStore

type WantsAggregateStore interface {
	registry.Watcher
	SetAggregateStore(store aggregatestore.Interface)
}

WantsAggregateStore defines a function which sets aggregate store for watcher plugins that need it.

type WantsStore

type WantsStore interface {
	registry.Watcher
	SetStore(store store.IStore)
}

WantsStore defines a function which sets store for watcher plugins that need it.

type WatcherInitializer

type WatcherInitializer struct {
	*AggregateConfig
}

WatcherInitializer is used for initialization of the onex specific watcher plugins.

func NewInitializer

func NewInitializer(aggregate *AggregateConfig) *WatcherInitializer

NewInitializer creates and returns a new WatcherInitializer instance.

func (*WatcherInitializer) Initialize

func (w *WatcherInitializer) Initialize(wc registry.Watcher)

Initialize configures the provided watcher by injecting dependencies such as the Store and AggregateConfig when supported by the watcher.