ipsecidx

Documentation

Index

• type SPDEntry
• type SPDIndex
• type SPDIndexRW
  • func NewSPDIndex(mapping idxvpp.NameToIdxRW) SPDIndexRW

Types

type SPDEntry

type SPDEntry struct {
	SPD   *ipsec.SecurityPolicyDatabases_SPD
	SpdID uint32
}

SPDEntry is used for matched SPD entries

type SPDIndex

type SPDIndex interface {
	// GetMapping returns internal read-only mapping with metadata of ipsec.SecurityPolicyDatabases_SPD type.
	GetMapping() idxvpp.NameToIdxRW

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

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

	// LookupByInterface returns structure with SPD interface assignment data.
	LookupByInterface(ifName string) []SPDEntry

	// LookupBySA returns structure with matched SPD entries.
	LookupBySA(saName string) []SPDEntry
}

SPDIndex provides read-only access to mapping between SPD data and SPD names

type SPDIndexRW

type SPDIndexRW interface {
	SPDIndex

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

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

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

SPDIndexRW is mapping between SPD data (metadata) and SPD entry names.

func NewSPDIndex

func NewSPDIndex(mapping idxvpp.NameToIdxRW) SPDIndexRW

NewSPDIndex creates new instance of spdIndex.