waits

Documentation

Index

• Constants
• func ReadWait(data json.RawMessage) (flows.Wait, error)
• func RegisterType(name string, f readFunc)
• type MsgWait
  • func NewMsgWait(timeout *int, hint flows.Hint) *MsgWait
  • func (w *MsgWait) Begin(run flows.FlowRun, log flows.EventCallback) bool
  • func (w *MsgWait) End(resume flows.Resume, node flows.Node) error
  • func (w *MsgWait) Hint() flows.Hint
  • func (w *MsgWait) MarshalJSON() ([]byte, error)
  • func (w *MsgWait) Timeout() *int
  • func (w *MsgWait) TimeoutOn() *time.Time
  • func (w *MsgWait) Type() string

Constants

const TypeMsg string = "msg"

TypeMsg is the type of our message wait

Functions

func ReadWait

func ReadWait(data json.RawMessage) (flows.Wait, error)

ReadWait reads a wait from the given JSON

func RegisterType

func RegisterType(name string, f readFunc)

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, hint flows.Hint) *MsgWait

NewMsgWait creates a new message wait

func (*MsgWait) Begin

func (w *MsgWait) Begin(run flows.FlowRun, log flows.EventCallback) bool

Begin beings waiting at this wait

func (*MsgWait) End

func (w *MsgWait) End(resume flows.Resume, node flows.Node) error

End ends this wait or returns an error

func (*MsgWait) Hint

func (w *MsgWait) Hint() flows.Hint

Hint returns the hint (optional)

func (*MsgWait) MarshalJSON

func (w *MsgWait) MarshalJSON() ([]byte, error)

MarshalJSON marshals this wait into JSON

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