waits

Documentation

Index

• Constants
• func WaitFromEnvelope(envelope *utils.TypedEnvelope) (flows.Wait, error)
• type BaseWait
  • func (w *BaseWait) Begin(run flows.FlowRun)
  • func (w *BaseWait) HasTimedOut() bool
  • func (w *BaseWait) Resume(run flows.FlowRun)
  • func (w *BaseWait) ResumeByTimeOut(run flows.FlowRun)
• type MsgWait
  • func NewMsgWait(timeout *int) *MsgWait
  • func (w *MsgWait) Begin(run flows.FlowRun, step flows.Step)
  • func (w *MsgWait) CanResume(run flows.FlowRun, step flows.Step) bool
  • func (w *MsgWait) ResumeByTimeOut(run flows.FlowRun)
  • func (w *MsgWait) Type() string
• type NothingWait
  • func (w *NothingWait) Begin(run flows.FlowRun, step flows.Step)
  • func (w *NothingWait) CanResume(run flows.FlowRun, step flows.Step) bool
  • func (w *NothingWait) Type() string
• type TimeoutWait
  • func (w *TimeoutWait) Begin(run flows.FlowRun)
  • func (w *TimeoutWait) HasTimedOut() bool

Constants

const TypeMsg string = "msg"

const TypeNothing string = "nothing"

Functions

func WaitFromEnvelope

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

Types

type BaseWait

type BaseWait struct {
}

Base of all wait types

func (*BaseWait) Begin

func (w *BaseWait) Begin(run flows.FlowRun)

func (*BaseWait) HasTimedOut

func (w *BaseWait) HasTimedOut() bool

func (*BaseWait) Resume

func (w *BaseWait) Resume(run flows.FlowRun)

func (*BaseWait) ResumeByTimeOut

func (w *BaseWait) ResumeByTimeOut(run flows.FlowRun)

type MsgWait

type MsgWait struct {
	TimeoutWait
}

func NewMsgWait

func NewMsgWait(timeout *int) *MsgWait

func (*MsgWait) Begin

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

func (*MsgWait) CanResume

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

CanResume returns true for a message wait if a message has now been received on this step

func (*MsgWait) ResumeByTimeOut

func (w *MsgWait) ResumeByTimeOut(run flows.FlowRun)

func (*MsgWait) Type

func (w *MsgWait) Type() string

type NothingWait

type NothingWait struct {
	BaseWait
}

func (*NothingWait) Begin

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

func (*NothingWait) CanResume

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

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

func (*NothingWait) Type

func (w *NothingWait) Type() string

type TimeoutWait

type TimeoutWait struct {
	BaseWait

	Timeout   *int       `json:"timeout,omitempty"`
	TimeoutOn *time.Time `json:"timeout_on,omitempty"`
}

Base of all wait types than can timeout

func (*TimeoutWait) Begin

func (w *TimeoutWait) Begin(run flows.FlowRun)

func (*TimeoutWait) HasTimedOut

func (w *TimeoutWait) HasTimedOut() bool