indications

Documentation

Index

• type DiscardOption
• type Event
• type EventType
• type ID
  • func GetID(message *e2ap.RicIndication) ID
  • func NewID(messageType sb.MessageType, plmnidn, ecid, crnti string) ID
• type Indication
  • func New(indication *e2ap.RicIndication) *Indication
• type LookupOption
• type RecordOption
• type Revision
• type Store
  • func NewDistributedStore(config config.Config) (Store, error)
  • func NewLocalStore() (Store, error)
• type WatchOption
  • func WithReplay() WatchOption

Types

type DiscardOption

type DiscardOption interface {
	// contains filtered or unexported methods
}

DiscardOption is an indication store discard option

type Event

type Event struct {
	// Type is the event type
	Type EventType

	// Indication is the indication
	Indication Indication
}

Event is a store event

type EventType

type EventType string

EventType is a store event type

const (
	// EventNone indicates an event that was not triggered but replayed
	EventNone EventType = ""
	// EventInsert indicates the message was inserted into the store
	EventInsert EventType = "insert"
	// EventUpdate indicates the message was updated in the store
	EventUpdate EventType = "update"
	// EventDelete indicates the message was deleted from the store
	EventDelete EventType = "remove"
)

type ID

type ID string

ID is a message identifier

func GetID

func GetID(message *e2ap.RicIndication) ID

GetID gets the telemetry store ID for the given message

func NewID

func NewID(messageType sb.MessageType, plmnidn, ecid, crnti string) ID

NewID creates a new telemetry store ID

type Indication

type Indication struct {
	*e2ap.RicIndication
	// ID is the unique indication identifier
	ID ID
	// Revision is the indication revision number
	Revision Revision
}

Indication is an indication message

func New

func New(indication *e2ap.RicIndication) *Indication

New creates a new indication

type LookupOption

type LookupOption interface {
	// contains filtered or unexported methods
}

LookupOption is an indication store lookup option

type RecordOption

type RecordOption interface {
	// contains filtered or unexported methods
}

RecordOption is an indication store record option

type Revision

type Revision uint64

Revision is a message revision number

type Store

type Store interface {
	io.Closer

	// Lookup looks up an indication by ID
	Lookup(ID, ...LookupOption) (*Indication, error)

	// Record records an indication in the store
	Record(*Indication, ...RecordOption) error

	// Discard discards an indication from the store
	Discard(ID, ...DiscardOption) error

	// List all of the last up to date messages
	List(ch chan<- Indication) error

	// Watch watches the store for changes
	Watch(ch chan<- Event, opts ...WatchOption) error

	// Clear deletes all messages from the store
	Clear() error
}

Store is interface for store

func NewDistributedStore

func NewDistributedStore(config config.Config) (Store, error)

NewDistributedStore creates a new distributed indications store

func NewLocalStore

func NewLocalStore() (Store, error)

NewLocalStore returns a new local indications store

type WatchOption

type WatchOption interface {
	// contains filtered or unexported methods
}

WatchOption is a message store watch option

func WithReplay

func WithReplay() WatchOption

WithReplay returns a watch option that replays existing messages