events

Documentation

Index

• Constants
• Variables
• type Event
• type Function
• type GenericSource
  • func (src *GenericSource) Close() error
  • func (src *GenericSource) EventID() ID
  • func (src *GenericSource) Ready() <-chan struct{}
  • func (src *GenericSource) Recv() (Event, error)
  • func (src *GenericSource) RecvMsg(m interface{}) error
• type Handler
  • func Always(fn func(ctx context.Context, message interface{})) Handler
  • func Once(fn func(ctx context.Context, message interface{})) Handler
• type ID
  • func New(name string) ID
• type Listener
• type ListenerCollection
  • func NewListenerCollection() *ListenerCollection
  • func (lc *ListenerCollection) Add(listener Listener)
  • func (lc *ListenerCollection) Remove(eventID ID, listenerID ListenerID)
  • func (lc *ListenerCollection) Size(eventID ID) int
  • func (lc *ListenerCollection) Values(eventID ID) []Listener
• type ListenerID
• type Loop
  • func NewLoop() *Loop
  • func (loop *Loop) AddListener(eventID ID, handler Handler) ListenerID
  • func (loop *Loop) AddSource(source Source)
  • func (loop *Loop) RemoveListener(eventID ID, listenerID ListenerID)
  • func (loop *Loop) RemoveSource(source Source)
  • func (loop *Loop) Run(ctx context.Context)
• type Source
  • func NewSource(eventID ID, stream rpcc.Stream, ...) Source
• type SourceCollection
  • func NewSourceCollection() *SourceCollection
  • func (sc *SourceCollection) Add(source Source)
  • func (sc *SourceCollection) Close() error
  • func (sc *SourceCollection) Get(idx int) (Source, error)
  • func (sc *SourceCollection) Remove(source Source) bool
  • func (sc *SourceCollection) Size() int
• type WaitTask
  • func NewEvalWaitTask(ec *eval.ExecutionContext, predicate string, polling time.Duration) *WaitTask
  • func NewValueWaitTask(when drivers.WaitEvent, value core.Value, getter Function, ...) *WaitTask
  • func NewWaitTask(fun Function, polling time.Duration) *WaitTask
  • func (task *WaitTask) Run(ctx context.Context) (core.Value, error)

Constants

const DefaultPolling = time.Millisecond * time.Duration(200)

Variables

var (
	Error = New("error")
)

Types

type Event

type Event struct {
	ID   ID
	Data interface{}
}

Event represents a system event that is returned from an event source

type Function

type Function func(ctx context.Context) (core.Value, error)

type GenericSource

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

GenericSource represents a helper struct for generating custom event sources

func (*GenericSource) Close

func (src *GenericSource) Close() error

func (*GenericSource) EventID

func (src *GenericSource) EventID() ID

func (*GenericSource) Ready

func (src *GenericSource) Ready() <-chan struct{}

func (*GenericSource) Recv

func (src *GenericSource) Recv() (Event, error)

func (*GenericSource) RecvMsg

func (src *GenericSource) RecvMsg(m interface{}) error

type Handler

type Handler func(ctx context.Context, message interface{}) bool

Handler represents a function that is called when a particular event occurs Returned boolean value indicates whether the handler needs to be called again False value indicated that it needs to be removed and never called again

func Always

func Always(fn func(ctx context.Context, message interface{})) Handler

Always returns a handler wrapper that always gets executed by an event loop

func Once

func Once(fn func(ctx context.Context, message interface{})) Handler

Once returns a handler wrapper that gets executed only once by an event loop

type ID

type ID int

ID represents a unique event ID

func New

func New(name string) ID

type Listener

type Listener struct {
	ID      ListenerID
	EventID ID
	Handler Handler
}

Listener is an internal listener representation

type ListenerCollection

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

func NewListenerCollection

func NewListenerCollection() *ListenerCollection

func (*ListenerCollection) Add

func (lc *ListenerCollection) Add(listener Listener)

func (*ListenerCollection) Remove

func (lc *ListenerCollection) Remove(eventID ID, listenerID ListenerID)

func (*ListenerCollection) Size

func (lc *ListenerCollection) Size(eventID ID) int

func (*ListenerCollection) Values

func (lc *ListenerCollection) Values(eventID ID) []Listener

type ListenerID

type ListenerID int

ListenerID is an internal listener ID that can be used to unsubscribe from a particular event

type Loop

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

func NewLoop

func NewLoop() *Loop

func (*Loop) AddListener

func (loop *Loop) AddListener(eventID ID, handler Handler) ListenerID

func (*Loop) AddSource

func (loop *Loop) AddSource(source Source)

func (*Loop) RemoveListener

func (loop *Loop) RemoveListener(eventID ID, listenerID ListenerID)

func (*Loop) RemoveSource

func (loop *Loop) RemoveSource(source Source)

func (*Loop) Run

func (loop *Loop) Run(ctx context.Context)

type Source

type Source interface {
	rpcc.Stream
	Recv() (Event, error)
}

Source represents a custom source of system events

func NewSource

func NewSource(
	eventID ID,
	stream rpcc.Stream,
	recv func(stream rpcc.Stream) (interface{}, error),
) Source

NewSource create a new custom event source eventID - is a unique event ID stream - is a custom event stream recv - is a value conversion function

type SourceCollection

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

func NewSourceCollection

func NewSourceCollection() *SourceCollection

func (*SourceCollection) Add

func (sc *SourceCollection) Add(source Source)

func (*SourceCollection) Close

func (sc *SourceCollection) Close() error

func (*SourceCollection) Get

func (sc *SourceCollection) Get(idx int) (Source, error)

func (*SourceCollection) Remove

func (sc *SourceCollection) Remove(source Source) bool

func (*SourceCollection) Size

func (sc *SourceCollection) Size() int

type WaitTask

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

func NewEvalWaitTask

func NewEvalWaitTask(
	ec *eval.ExecutionContext,
	predicate string,
	polling time.Duration,
) *WaitTask

func NewValueWaitTask

func NewValueWaitTask(
	when drivers.WaitEvent,
	value core.Value,
	getter Function,
	polling time.Duration,
) *WaitTask

func NewWaitTask

func NewWaitTask(
	fun Function,
	polling time.Duration,
) *WaitTask

func (*WaitTask) Run

func (task *WaitTask) Run(ctx context.Context) (core.Value, error)