synchronizer

Documentation

Overview

Package synchronizer synchronizes configurations down to devices

Index

• func WithDeviceChangeStore(deviceChangeStore device.Store) func(*Factory)
• func WithDispatcher(dispatcher *dispatcher.Dispatcher) func(*Factory)
• func WithModelRegistry(modelRegistry *modelregistry.ModelRegistry) func(*Factory)
• func WithNewTargetFn(newTargetFn func() southbound.TargetIf) func(*Factory)
• func WithOpStateChannel(opStateChan chan<- events.OperationalStateEvent) func(*Factory)
• func WithOperationalStateCache(operationalStateCache map[topodevice.ID]devicechange.TypedValueMap) func(*Factory)
• func WithOperationalStateCacheLock(operationalStateCacheLock *syncPrimitives.RWMutex) func(*Factory)
• func WithSouthboundErrChan(southboundErrorChan chan<- events.DeviceResponse) func(*Factory)
• func WithTopoChannel(topoChannel <-chan *topodevice.ListResponse) func(*Factory)
• type Factory
  • func NewFactory(options ...func(*Factory)) (*Factory, error)
  • func (f *Factory) TopoEventHandler()
• type Synchronizer
  • func New(context context.Context, device *topodevice.Device, ...) (*Synchronizer, error)

Functions

func WithDeviceChangeStore

func WithDeviceChangeStore(deviceChangeStore device.Store) func(*Factory)

WithDeviceChangeStore sets factory device change store

func WithDispatcher

func WithDispatcher(dispatcher *dispatcher.Dispatcher) func(*Factory)

WithDispatcher sets factory dispatcher

func WithModelRegistry

func WithModelRegistry(modelRegistry *modelregistry.ModelRegistry) func(*Factory)

WithModelRegistry set factory model registry

func WithNewTargetFn

func WithNewTargetFn(newTargetFn func() southbound.TargetIf) func(*Factory)

WithNewTargetFn sets factory southbound target function

func WithOpStateChannel

func WithOpStateChannel(opStateChan chan<- events.OperationalStateEvent) func(*Factory)

WithOpStateChannel sets factory opStateChannel

func WithOperationalStateCache

func WithOperationalStateCache(operationalStateCache map[topodevice.ID]devicechange.TypedValueMap) func(*Factory)

WithOperationalStateCache sets factory operational state cache

func WithOperationalStateCacheLock

func WithOperationalStateCacheLock(operationalStateCacheLock *syncPrimitives.RWMutex) func(*Factory)

WithOperationalStateCacheLock sets factory operational state cache lock

func WithSouthboundErrChan

func WithSouthboundErrChan(southboundErrorChan chan<- events.DeviceResponse) func(*Factory)

WithSouthboundErrChan sets factory southbound error channel

func WithTopoChannel

func WithTopoChannel(topoChannel <-chan *topodevice.ListResponse) func(*Factory)

WithTopoChannel sets factory topo channel

Types

type Factory

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

Factory device factory data structures

func NewFactory

func NewFactory(options ...func(*Factory)) (*Factory, error)

NewFactory create a new factory

func (*Factory) TopoEventHandler

func (f *Factory) TopoEventHandler()

TopoEventHandler handle topo device events

type Synchronizer

type Synchronizer struct {
	context.Context
	*topodevice.Device
	// contains filtered or unexported fields
}

Synchronizer enables proper configuring of a device based on store events and cache of operational data

func New

func New(context context.Context,
	device *topodevice.Device, opStateChan chan<- events.OperationalStateEvent,
	errChan chan<- events.DeviceResponse, opStateCache devicechange.TypedValueMap,
	mReadOnlyPaths modelregistry.ReadOnlyPathMap, target southbound.TargetIf, getStateMode modelregistry.GetStateMode,
	opStateCacheLock *syncPrimitives.RWMutex, deviceChangeStore device.Store) (*Synchronizer, error)

New builds a new Synchronizer given the parameters, starts the connection with the device and polls the capabilities