ready

Documentation

Index

• func ReadyDispatcher(evt pubsub.Event, fn pubsub.SubscriberFn) error
• type ReadyFunc
• type ReadyManager
  • func NewReadyManager() *ReadyManager
  • func (m *ReadyManager) AwaitReady() error
  • func (m *ReadyManager) FireReady(err error) error
  • func (m *ReadyManager) OnReady(ready ReadyFunc)

Functions

func ReadyDispatcher

func ReadyDispatcher(evt pubsub.Event, fn pubsub.SubscriberFn) error

ReadyDispatcher is just an pubsub dispatcher where the callback is ReadyFunc

Types

type ReadyFunc

type ReadyFunc func(error)

ReadyFunc is function that gets called once when an event is ready

type ReadyManager

type ReadyManager struct {
	Stop context.CancelFunc
	// contains filtered or unexported fields
}

ReadyManager managers listeners for a ready event

func NewReadyManager

func NewReadyManager() *ReadyManager

func (*ReadyManager) AwaitReady

func (m *ReadyManager) AwaitReady() error

AwaitReady blocks until the ready event fires. Returns immediately if the event already fired.

func (*ReadyManager) FireReady

func (m *ReadyManager) FireReady(err error) error

FireReady is called when the ready event occurs

func (*ReadyManager) OnReady

func (m *ReadyManager) OnReady(ready ReadyFunc)

OnReady registers a listener for the ready event. If the event has already been fired, the callback is immediately called back (in a go-routine).