events

Documentation

Index

• type Event
• type Evented
  • func (s *Evented) Emit(e Event)
  • func (s *Evented) Notify(ctx context.Context)
  • func (s *Evented) Subscribe(o Observer)
  • func (s *Evented) Unsubscribe(o Observer)
• type Observer
• type ObserverFunc
  • func (o ObserverFunc) On(ctx context.Context, e Event)
• type Subject

Types

type Event

type Event struct {
	Name     string
	EntityID string
	Payload  interface{}
}

Event holds data on system and domain events

type Evented

type Evented struct {
	Events    []Event
	Observers []Observer
}

Evented embeddedable interface that implements observer

func (*Evented) Emit

func (s *Evented) Emit(e Event)

Emit queues an event for notification.

func (*Evented) Notify

func (s *Evented) Notify(ctx context.Context)

Notify flushes and sends notifications.

func (*Evented) Subscribe

func (s *Evented) Subscribe(o Observer)

Subscribe adds Observers to send events to

func (*Evented) Unsubscribe

func (s *Evented) Unsubscribe(o Observer)

Unsubscribe removes an observer from being notified

type Observer

type Observer interface {
	On(context.Context, Event)
}

Observer implementers will be notified when events occur

type ObserverFunc

type ObserverFunc func(context.Context, Event)

ObserverFunc function wrapper for Observer interface

func (ObserverFunc) On

func (o ObserverFunc) On(ctx context.Context, e Event)

On statifies Observer interface

type Subject

type Subject interface {
	Subscribe(o Observer)
	Unsubscribe(o Observer)
	Emit(e Event)
	Notify(context.Context)
}

Subject defines components that can be observered