synchronizer

Documentation

Overview

Package synchronizer synchronizes configurations down to devices

Index

• func WithDeviceChangeStore(deviceChangeStore device.Store) func(*SessionManager)
• func WithDeviceStore(deviceStore devicestore.Store) func(*SessionManager)
• func WithDispatcher(dispatcher *dispatcher.Dispatcher) func(*SessionManager)
• func WithMastershipStore(mastershipStore mastership.Store) func(*SessionManager)
• func WithModelRegistry(modelRegistry *modelregistry.ModelRegistry) func(*SessionManager)
• func WithNewTargetFn(newTargetFn func() southbound.TargetIf) func(*SessionManager)
• func WithOpStateChannel(opStateChan chan<- events.OperationalStateEvent) func(*SessionManager)
• func WithOperationalStateCache(operationalStateCache map[topodevice.ID]devicechange.TypedValueMap) func(*SessionManager)
• func WithOperationalStateCacheLock(operationalStateCacheLock *sync.RWMutex) func(*SessionManager)
• func WithSessions(sessions map[topodevice.ID]*Session) func(*SessionManager)
• func WithTopoChannel(topoChannel chan *topodevice.ListResponse) func(*SessionManager)
• type Session
  • func (s *Session) Close()
• type SessionManager
  • func NewSessionManager(options ...func(*SessionManager)) (*SessionManager, error)
  • func (sm *SessionManager) Start() error
• type Synchronizer
  • func New(context context.Context, device *topodevice.Device, ...) (*Synchronizer, error)

Functions

func WithDeviceChangeStore

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

WithDeviceChangeStore sets device change store

func WithDeviceStore

func WithDeviceStore(deviceStore devicestore.Store) func(*SessionManager)

WithDeviceStore sets device store

func WithDispatcher

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

WithDispatcher sets dispatcher

func WithMastershipStore

func WithMastershipStore(mastershipStore mastership.Store) func(*SessionManager)

WithMastershipStore sets mastership store

func WithModelRegistry

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

WithModelRegistry sets model registry

func WithNewTargetFn

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

WithNewTargetFn sets southbound target function

func WithOpStateChannel

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

WithOpStateChannel sets opStateChannel

func WithOperationalStateCache

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

WithOperationalStateCache sets operational state cache

func WithOperationalStateCacheLock

func WithOperationalStateCacheLock(operationalStateCacheLock *sync.RWMutex) func(*SessionManager)

WithOperationalStateCacheLock sets operational state cache lock

func WithSessions

func WithSessions(sessions map[topodevice.ID]*Session) func(*SessionManager)

WithSessions sets list of sessions

func WithTopoChannel

func WithTopoChannel(topoChannel chan *topodevice.ListResponse) func(*SessionManager)

WithTopoChannel sets topo channel

Types

type Session

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

Session a gNMI session

func (*Session) Close

func (s *Session) Close()

Close close a gNMI session

type SessionManager

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

SessionManager is a gNMI session manager

func NewSessionManager

func NewSessionManager(options ...func(*SessionManager)) (*SessionManager, error)

NewSessionManager create a new session manager

func (*SessionManager) Start

func (sm *SessionManager) Start() error

Start starts session manager

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 configmodel.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