waits

Documentation

Index

• Constants
• func ReadWait(envelope *utils.TypedEnvelope) (flows.Wait, error)
• func RegisterType(name string, initFunc func() flows.Wait)
• type MsgWait
  • func NewMsgWait(timeout *int) *MsgWait
  • func (w *MsgWait) Begin(run flows.FlowRun, step flows.Step)
  • func (w *MsgWait) CanResume(callerEvents []flows.CallerEvent) bool
  • func (w *MsgWait) Timeout() *int
  • func (w *MsgWait) TimeoutOn() *time.Time
  • func (w *MsgWait) Type() string
• type NothingWait
  • func (w *NothingWait) Begin(run flows.FlowRun, step flows.Step)
  • func (w *NothingWait) CanResume(callerEvents []flows.CallerEvent) bool
  • func (w *NothingWait) Timeout() *int
  • func (w *NothingWait) TimeoutOn() *time.Time
  • func (w *NothingWait) Type() string

Constants

const TypeMsg string = "msg"

const TypeNothing string = "nothing"

Functions

func ReadWait

func ReadWait(envelope *utils.TypedEnvelope) (flows.Wait, error)

ReadWait reads a wait from the given typed envelope

func RegisterType

func RegisterType(name string, initFunc func() flows.Wait)

RegisterType registers a new type of wait

Types

type MsgWait

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

MsgWait is a wait which waits for an incoming message (i.e. a msg_received event)

func NewMsgWait

func NewMsgWait(timeout *int) *MsgWait

NewMsgWait creates a new message wait

func (*MsgWait) Begin

func (w *MsgWait) Begin(run flows.FlowRun, step flows.Step)

Begin beings waiting at this wait

func (*MsgWait) CanResume

func (w *MsgWait) CanResume(callerEvents []flows.CallerEvent) bool

CanResume returns true if a message event has been received

func (*MsgWait) Timeout

func (w *MsgWait) Timeout() *int

Timeout returns the timeout of this wait in seconds or nil if no timeout is set

func (*MsgWait) TimeoutOn

func (w *MsgWait) TimeoutOn() *time.Time

TimeoutOn returns when this wait times out

func (*MsgWait) Type

func (w *MsgWait) Type() string

Type returns the type of this wait

type NothingWait

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

NothingWait is a wait which waits for nothing.. i.e. a chance for the caller to do something and resume immediately

func (*NothingWait) Begin

func (w *NothingWait) Begin(run flows.FlowRun, step flows.Step)

Begin beings waiting at this wait

func (*NothingWait) CanResume

func (w *NothingWait) CanResume(callerEvents []flows.CallerEvent) bool

CanResume always returns true for a nothing wait because it's not waiting for anything

func (*NothingWait) Timeout

func (w *NothingWait) Timeout() *int

Timeout would return the timeout of this wait for wait types that do that

func (*NothingWait) TimeoutOn

func (w *NothingWait) TimeoutOn() *time.Time

TimeoutOn would return when this wait times out for wait types that do that

func (*NothingWait) Type

func (w *NothingWait) Type() string

Type returns the type of this wait