waits

Documentation

Index

• Constants
• func ReadActivatedWait(data json.RawMessage) (flows.ActivatedWait, error)
• func ReadWait(data json.RawMessage) (flows.Wait, error)
• func RegisterType(name string, f1 readFunc, f2 readActivatedFunc)
• type ActivatedMsgWait
  • func NewActivatedMsgWait(timeoutSeconds *int, hint flows.Hint) *ActivatedMsgWait
  • func (w *ActivatedMsgWait) Hint() flows.Hint
  • func (w *ActivatedMsgWait) MarshalJSON() ([]byte, error)
  • func (w *ActivatedMsgWait) TimeoutSeconds() *int
  • func (w *ActivatedMsgWait) Type() string
• type MsgWait
  • func NewMsgWait(timeout *Timeout, hint flows.Hint) *MsgWait
  • func (w *MsgWait) Begin(run flows.FlowRun, log flows.EventCallback) flows.ActivatedWait
  • func (w *MsgWait) End(resume flows.Resume) error
  • func (w *MsgWait) Hint() flows.Hint
  • func (w *MsgWait) MarshalJSON() ([]byte, error)
  • func (w *MsgWait) Timeout() flows.Timeout
  • func (w *MsgWait) Type() string
• type Timeout
  • func NewTimeout(seconds int, categoryUUID flows.CategoryUUID) *Timeout
  • func (t *Timeout) CategoryUUID() flows.CategoryUUID
  • func (t *Timeout) Seconds() int

Constants

const TypeMsg string = "msg"

TypeMsg is the type of our message wait

Functions

func ReadActivatedWait

func ReadActivatedWait(data json.RawMessage) (flows.ActivatedWait, error)

ReadActivatedWait reads an activated wait from the given JSON

func ReadWait

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

ReadWait reads a wait from the given JSON

func RegisterType

func RegisterType(name string, f1 readFunc, f2 readActivatedFunc)

RegisterType registers a new type of wait

Types

type ActivatedMsgWait

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

func NewActivatedMsgWait

func NewActivatedMsgWait(timeoutSeconds *int, hint flows.Hint) *ActivatedMsgWait

func (*ActivatedMsgWait) Hint

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

Hint returns the hint (optional)

func (*ActivatedMsgWait) MarshalJSON

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

MarshalJSON marshals this wait into JSON

func (*ActivatedMsgWait) TimeoutSeconds

func (w *ActivatedMsgWait) TimeoutSeconds() *int

func (*ActivatedMsgWait) Type

func (w *ActivatedMsgWait) Type() string

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

NewMsgWait creates a new message wait

func (*MsgWait) Begin

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

Begin beings waiting at this wait

func (*MsgWait) End

func (w *MsgWait) End(resume flows.Resume) 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() flows.Timeout

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

func (*MsgWait) Type

func (w *MsgWait) Type() string

Type returns the type of this wait

type Timeout

type Timeout struct {
	Seconds_      int                `json:"seconds"       validate:"required"`
	CategoryUUID_ flows.CategoryUUID `json:"category_uuid" validate:"required,uuid4"`
}

func NewTimeout

func NewTimeout(seconds int, categoryUUID flows.CategoryUUID) *Timeout

func (*Timeout) CategoryUUID

func (t *Timeout) CategoryUUID() flows.CategoryUUID

func (*Timeout) Seconds

func (t *Timeout) Seconds() int