event

Documentation

Index

• type Event
• type EventListener
• type EventManager
  • func NewEventManager() *EventManager
  • func (m *EventManager) RegisterListener(eventType EventType, listener chan Event) int
  • func (m *EventManager) RemoveListener(id int) int
  • func (m *EventManager) ReportError(err error)
  • func (m *EventManager) ReportFatalError(err error)
  • func (m *EventManager) Send(evt Event)
• type EventType
• type Manager

Types

type Event

type Event struct {
	Type    EventType
	Payload any
}

nolint:revive Event data structure representing any event we may want to react to

type EventListener

type EventListener struct {
	ID int
	// contains filtered or unexported fields
}

nolint:revive EventListener represents a single listener for an event channel

type EventManager

type EventManager struct {
	// contains filtered or unexported fields
}

nolint:revive EventManager implements the event.Manager interface

func NewEventManager

func NewEventManager() *EventManager

NewEventManager returns a new instance of EventManager

func (*EventManager) RegisterListener

func (m *EventManager) RegisterListener(eventType EventType, listener chan Event) int

RegisterListener registers a listener with the event manager

func (*EventManager) RemoveListener

func (m *EventManager) RemoveListener(id int) int

RemoveListener removes a listener from the event manager

func (*EventManager) ReportError

func (m *EventManager) ReportError(err error)

ReportError reports an error to all listeners for that event

func (*EventManager) ReportFatalError

func (m *EventManager) ReportFatalError(err error)

ReportFatalError reports a fatal error to all listeners for that event

func (*EventManager) Send

func (m *EventManager) Send(evt Event)

Send sends an event to all listeners for that event

type EventType

type EventType string

nolint:revive EventType represents different types of events

const (
	// FatalErrorEventType represents a fatal error
	FatalErrorEventType EventType = "fatal-error"
	// ErrorEventType represents a regular error
	ErrorEventType EventType = "error"
)

type Manager

type Manager interface {
	RegisterListener(eventType EventType, listener chan Event) int
	RemoveListener(id int) int
	Send(event Event)
	ReportFatalError(err error)
	ReportError(err error)
}

Manager is an interface for managing app wide events