event

Documentation

Index

• Constants
• type Bus
  • func NewEventBus() Bus
• type Callback
• type Event
• type Queue
  • func NewQueue(cap int) Queue

Constants

const (
	// MaxEventNum is the default size of a event queue.
	MaxEventNum = 200
)

Types

type Bus

type Bus interface {
	Watch(event string, callback Callback)
	Unwatch(event string, callback Callback)
	Dispatch(event *Event)
	DispatchAndWait(event *Event)
}

Bus implements the observer pattern to allow event dispatching and watching.

func NewEventBus

func NewEventBus() Bus

NewEventBus creates a Bus.

type Callback

type Callback func(*Event)

Callback is called when the subscribed event happens.

type Event

type Event struct {
	Name   string
	Time   time.Time
	Detail string
	Extra  interface{}
}

Event represents an event.

type Queue

type Queue interface {
	Push(e *Event)
	Dump() interface{}
}

Queue is a ring to collect events.

func NewQueue

func NewQueue(cap int) Queue

NewQueue creates a queue with the given capacity.