abxidx

Documentation

Index

• type ABXMetadata
  • func (m *ABXMetadata) GetIndex() uint32
• type ABXMetadataDto
• type ABXMetadataIndex
• type ABXMetadataIndexRW
  • func NewABXIndex(logger logging.Logger, title string) ABXMetadataIndexRW
• type Attached

Types

type ABXMetadata

type ABXMetadata struct {
	Index    uint32
	Attached []*abx.ABX_AttachedInterface
}

ABXMetadata represents metadata for ABX.

func (*ABXMetadata) GetIndex

func (m *ABXMetadata) GetIndex() uint32

GetIndex returns index of the ABX.

type ABXMetadataDto

type ABXMetadataDto struct {
	idxmap.NamedMappingEvent
	Metadata *ABXMetadata
}

ABXMetadataDto represents an item sent through watch channel in abxIndex.

type ABXMetadataIndex

type ABXMetadataIndex interface {
	// LookupIdx looks up previously stored item identified by index in the mapping.
	LookupByName(name string) (metadata *ABXMetadata, exists bool)

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

ABXMetadataIndex provides read-only access to mapping between ABX indexes (generated in the ABX plugin) and ABX names.

type ABXMetadataIndexRW

type ABXMetadataIndexRW interface {
	ABXMetadataIndex
	idxmap.NamedMappingRW
}

ABXMetadataIndexRW is mapping between ABX indexes (generated in the ABX plugin) and ABX names.

func NewABXIndex

func NewABXIndex(logger logging.Logger, title string) ABXMetadataIndexRW

NewABXIndex creates new instance of abxMetadataIndex.

type Attached

type Attached struct {
	Name     string
	Priority uint32
}

Attached is helper struct for metadata (ABX attached interface).