ifaceidx

type DHCPSettings struct {
	IfName        string
	IsIPv6        bool
	IPAddress     string
	Mask          uint32
	PhysAddress   string
	RouterAddress string
}

type DhcpIdxDto struct {
	idxvpp.NameToIdxDtoWithoutMeta
	Metadata *DHCPSettings
}

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

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

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

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

type DhcpIndexRW interface {
	DhcpIndex

	// RegisterName adds a new item into name-to-index mapping.
	RegisterName(name string, idx uint32, ifMeta *DHCPSettings)

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

type SwIfIdxDto struct {
	idxvpp.NameToIdxDtoWithoutMeta
	Metadata *intf.Interfaces_Interface
}

type SwIfIndex 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 *intf.Interfaces_Interface, exists bool)

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

	// LookupNameByIP returns name of items, that contains given IP address in metadata.
	LookupNameByIP(ip string) []string

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

type SwIfIndexRW interface {
	SwIfIndex

	// RegisterName adds a new item into name-to-index mapping.
	RegisterName(name string, idx uint32, ifMeta *intf.Interfaces_Interface)

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

	// UpdateMetadata updates metadata in existing interface entry.
	UpdateMetadata(name string, metadata *intf.Interfaces_Interface) (success bool)
}