l2idx

type BDIndex interface {
	// GetMapping returns internal read-only mapping with metadata of type interface{}.
	GetMapping() idxvpp.NameToIdxRW

	// LookupIdx looks up previously stored item identified by index in mapping.
	LookupIdx(name string) (idx uint32, metadata *BdMetadata, exists bool)

	// LookupName looks up previously stored item identified by name in mapping.
	LookupName(idx uint32) (name string, metadata *BdMetadata, exists bool)

	// LookupBdForInterface looks up for bridge domain the interface belongs to
	LookupBdForInterface(ifName string) (bdIdx uint32, bd *l2.BridgeDomains_BridgeDomain, bdIf *l2.BridgeDomains_BridgeDomain_Interfaces, exists bool)

	// LookupConfiguredIfsForBd return a list of configured interfaces for bridge domain
	LookupConfiguredIfsForBd(bdName string) ([]string, bool)

	// WatchNameToIdx allows to subscribe for watching changes in bdIndex mapping
	WatchNameToIdx(subscriber core.PluginName, pluginChannel chan BdChangeDto)
}

type BDIndexRW interface {
	BDIndex

	// RegisterName adds new item into name-to-index mapping.
	RegisterName(name string, idx uint32, metadata *BdMetadata)

	// UnregisterName removes an item identified by name from mapping.
	UnregisterName(name string) (idx uint32, metadata *BdMetadata, exists bool)

	// UpdateMetadata updates metadata in existing bridge domain entry.
	UpdateMetadata(name string, metadata *BdMetadata) (success bool)

	// Clear removes all bridge domains from the mapping.
	Clear()
}

type BdChangeDto struct {
	idxvpp.NameToIdxDtoWithoutMeta
	Metadata *BdMetadata
}

type BdMetadata struct {
	BridgeDomain         *l2.BridgeDomains_BridgeDomain
	ConfiguredInterfaces []string
}

type FIBIndex interface {
	// GetMapping returns internal read-only mapping with metadata of type interface{}.
	GetMapping() idxvpp.NameToIdxRW

	// LookupIdx looks up previously stored item identified by index in mapping.
	LookupIdx(name string) (idx uint32, metadata *l2.FibTable_FibEntry, exists bool)

	// LookupName looks up previously stored item identified by name in mapping.
	LookupName(idx uint32) (name string, metadata *l2.FibTable_FibEntry, exists bool)

	// WatchNameToIdx allows to subscribe for watching changes in fibIndex mapping
	WatchNameToIdx(subscriber core.PluginName, pluginChannel chan FibChangeDto)
}

type FIBIndexRW interface {
	FIBIndex

	// RegisterName adds new item into name-to-index mapping.
	RegisterName(name string, idx uint32, metadata *l2.FibTable_FibEntry)

	// UnregisterName removes an item identified by name from mapping.
	UnregisterName(name string) (idx uint32, metadata *l2.FibTable_FibEntry, exists bool)

	// UpdateMetadata updates metadata in existing FIB entry.
	UpdateMetadata(name string, metadata *l2.FibTable_FibEntry) (success bool)

	// Clear removes all FIB entries from the mapping.
	Clear()
}

type FibChangeDto struct {
	idxvpp.NameToIdxDtoWithoutMeta
	Metadata *l2.FibTable_FibEntry
}

type XcChangeDto struct {
	idxvpp.NameToIdxDtoWithoutMeta
	Metadata *l2.XConnectPairs_XConnectPair
}

type XcIndex interface {
	// GetMapping returns internal read-only mapping with metadata of type interface{}.
	GetMapping() idxvpp.NameToIdxRW

	// LookupIdx looks up previously stored item identified by index in mapping.
	LookupIdx(name string) (idx uint32, metadata *l2.XConnectPairs_XConnectPair, exists bool)

	// LookupName looks up previously stored item identified by name in mapping.
	LookupName(idx uint32) (name string, metadata *l2.XConnectPairs_XConnectPair, exists bool)

	// WatchNameToIdx allows to subscribe for watching changes in xcIndex mapping
	WatchNameToIdx(subscriber core.PluginName, pluginChannel chan XcChangeDto)
}

type XcIndexRW interface {
	XcIndex

	// RegisterName adds new item into name-to-index mapping.
	RegisterName(name string, idx uint32, metadata *l2.XConnectPairs_XConnectPair)

	// UnregisterName removes an item identified by name from mapping.
	UnregisterName(name string) (idx uint32, metadata *l2.XConnectPairs_XConnectPair, exists bool)

	// UpdateMetadata updates metadata in existing cross connect entry.
	UpdateMetadata(name string, metadata *l2.XConnectPairs_XConnectPair) (success bool)

	// Clear removes all cross connects from the mapping.
	Clear()
}