events

Documentation

Index

• type Dispatcher
  • func NewDispatcher(log *zap.Logger) *Dispatcher
  • func (d *Dispatcher) Dispatch(event Event)
  • func (d *Dispatcher) Register(listener ...EventListener)
• type Event
• type EventListener
• type EventName

Types

type Dispatcher

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

Dispatcher is used to dispatch events to listeners

func NewDispatcher

func NewDispatcher(log *zap.Logger) *Dispatcher

NewDispatcher returns a new dispatcher instance

func (*Dispatcher) Dispatch

func (d *Dispatcher) Dispatch(event Event)

Dispatch given event

func (*Dispatcher) Register

func (d *Dispatcher) Register(listener ...EventListener)

Register events listeners

type Event

type Event interface {
	Name() EventName
}

Event is a event that can be dispatched and 0 .. n listeners may listen for

type EventListener

type EventListener interface {
	ForEvent() EventName
	Handle(ev Event) error
}

EventListener enables to listen for a certain event

type EventName

type EventName string

EventName is the unique name of the event