event

Documentation

Index

• type Bus
• type Consumer
• type ErrConsumeFailed
  • func (e ErrConsumeFailed) Error() string
• type ErrProduceFailed
  • func (e ErrProduceFailed) Error() string
• type Event
  • func (e *Event) Conforms(target, name string) bool
• type EventCategory
  • func (ec EventCategory) IsCustom() bool
  • func (ec EventCategory) IsEvent() bool
  • func (ec EventCategory) IsModel() bool
  • func (ec EventCategory) IsSystem() bool
• type Listener
• type Producer

Types

type Bus

type Bus interface {
	Consumer
	Producer
}

Bus connects event Consumer and Producer.

type Consumer

type Consumer interface {
	Consume(buf []Event, ctx context.Context) error
}

type ErrConsumeFailed

type ErrConsumeFailed struct {
	Reason error
}

Bus connected consumer failed to consume events

func (ErrConsumeFailed) Error

func (e ErrConsumeFailed) Error() string

type ErrProduceFailed

type ErrProduceFailed struct {
	Reason error
}

Bus connected provider failed to provide events

func (ErrProduceFailed) Error

func (e ErrProduceFailed) Error() string

type Event

type Event struct {
	Target   string        `json:"target"`
	Category EventCategory `json:"category"`
	Name     string        `json:"name"`
	Time     time.Time     `json:"time"`
	Data     interface{}   `json:"data,omitempty"`
}

func (*Event) Conforms

func (e *Event) Conforms(target, name string) bool

type EventCategory

type EventCategory string

const (
	CategorySystem EventCategory = "system"
	CategoryModel  EventCategory = "model"
	CategoryEvent  EventCategory = "event"
)

Event categories

func (EventCategory) IsCustom

func (ec EventCategory) IsCustom() bool

Test if the event category is custom

func (EventCategory) IsEvent

func (ec EventCategory) IsEvent() bool

Test if the event category is event

func (EventCategory) IsModel

func (ec EventCategory) IsModel() bool

Test if the event category is model

func (EventCategory) IsSystem

func (ec EventCategory) IsSystem() bool

Test if the event category is system

type Listener

type Listener interface {
	Listen(buf []Event)
}

type Producer

type Producer interface {
	Produce(buf []Event, ctx context.Context) (n int, err error)
}