message

Documentation

Index

• Variables
• func GetAbortKey(id string) string
• type Message
  • func NewMessage(msgArgs MessageArgs) Message
  • func (m Message) IsRunTime() bool
  • func (m Message) RunTimeAfter(t time.Time) bool
  • func (m Message) RunTimeAfterOrEqual(t time.Time) bool
  • func (m Message) RunTimeBefore(t time.Time) bool
  • func (m Message) RunTimeBeforeOrEqual(t time.Time) bool
  • func (m Message) RunTimeEqual(t time.Time) bool
  • func (m *Message) SetArgs(args ...interface{}) error
• type MessageArgs
  • func NewMsgArgs() MessageArgs
  • func (t *MessageArgs) AppendWorkflow(work MessageWorkflowArgs)
  • func (t MessageArgs) GetRunTime() time.Time
  • func (m MessageArgs) IsDelayMessage() bool
• type MessageWorkflowArgs
• type Result
  • func NewAbortResult(id string) Result
  • func NewResult(id string) Result
  • func (r Result) Get(index int, v interface{}) error
  • func (r Result) GetBackendKey() string
  • func (r Result) GetBool(index int) (bool, error)
  • func (r Result) GetFloat64(index int) (float64, error)
  • func (r Result) GetInt64(index int) (int64, error)
  • func (r Result) GetInterface(index int) (interface{}, error)
  • func (r Result) GetString(index int) (string, error)
  • func (r Result) GetUint64(index int) (uint64, error)
  • func (r Result) Gets(args ...interface{}) error
  • func (r Result) IsFailure() bool
  • func (r Result) IsFinish() bool
  • func (r Result) IsSuccess() bool
  • func (r *Result) SetStatusRunning()

Variables

var ResultStatus = resultStatusChoice{
	Sent:         0,
	FirstRunning: 1,
	WaitingRetry: 2,
	Running:      3,
	Success:      4,
	Failure:      5,
	Expired:      6,
	Abort:        7,
}

var StatusToWorkflowStatus = map[int]string{
	ResultStatus.Sent:         WorkflowStatus.Waiting,
	ResultStatus.FirstRunning: WorkflowStatus.Running,
	ResultStatus.WaitingRetry: WorkflowStatus.Running,
	ResultStatus.Running:      WorkflowStatus.Running,
	ResultStatus.Success:      WorkflowStatus.Success,
	ResultStatus.Failure:      WorkflowStatus.Failure,
	ResultStatus.Expired:      WorkflowStatus.Expired,
	ResultStatus.Abort:        WorkflowStatus.Abort,
}

var WorkflowStatus = workflowStatusChoice{
	Waiting: "waiting",
	Running: "running",
	Success: "success",
	Failure: "failure",
	Expired: "expired",
	Abort:   "abort",
}

Functions

func GetAbortKey

func GetAbortKey(id string) string

结束任务标志

Types

type Message

type Message struct {
	Id         string      `json:"id"`
	WorkerName string      `json:"worker_name"`
	FuncArgs   []string    `json:"func_args"`
	MsgArgs    MessageArgs `v2JsonName:"TaskCtl"` // 为了方便client端send时通过SetTaskCtl修改相关参数

}

func NewMessage

func NewMessage(msgArgs MessageArgs) Message

func (Message) IsRunTime

func (m Message) IsRunTime() bool

func (Message) RunTimeAfter

func (m Message) RunTimeAfter(t time.Time) bool

func (Message) RunTimeAfterOrEqual

func (m Message) RunTimeAfterOrEqual(t time.Time) bool

func (Message) RunTimeBefore

func (m Message) RunTimeBefore(t time.Time) bool

func (Message) RunTimeBeforeOrEqual

func (m Message) RunTimeBeforeOrEqual(t time.Time) bool

func (Message) RunTimeEqual

func (m Message) RunTimeEqual(t time.Time) bool

func (*Message) SetArgs

func (m *Message) SetArgs(args ...interface{}) error

type MessageArgs

type MessageArgs struct {
	RetryCount int
	RunTime    time.Time
	ExpireTime time.Time
	Workflow   []MessageWorkflowArgs `json:"workflow"`
}

func NewMsgArgs

func NewMsgArgs() MessageArgs

func (*MessageArgs) AppendWorkflow

func (t *MessageArgs) AppendWorkflow(work MessageWorkflowArgs)

func (MessageArgs) GetRunTime

func (t MessageArgs) GetRunTime() time.Time

func (MessageArgs) IsDelayMessage

func (m MessageArgs) IsDelayMessage() bool

type MessageWorkflowArgs

type MessageWorkflowArgs struct {
	GroupName  string
	WorkerName string
	RetryCount int
	RunAfter   time.Duration
	ExpireTime time.Time
}

type Result

type Result struct {
	Id         string      `json:"id"`
	Status     int         `json:"status"` // 0:sent , 1:first running , 2: waiting to retry , 3: running , 4: success , 5: Failure
	FuncReturn []string    `json:"func_return"`
	RetryCount int         `json:"retry_count"`
	Workflow   [][2]string `json:"workflow"` // [["workName","status"],] ;  status: waiting , running , success , failure , expired , abort
	Err        string      `json:"err"`
}

func NewAbortResult

func NewAbortResult(id string) Result

func NewResult

func NewResult(id string) Result

func (Result) Get

func (r Result) Get(index int, v interface{}) error

func (Result) GetBackendKey

func (r Result) GetBackendKey() string

func (Result) GetBool

func (r Result) GetBool(index int) (bool, error)

func (Result) GetFloat64

func (r Result) GetFloat64(index int) (float64, error)

func (Result) GetInt64

func (r Result) GetInt64(index int) (int64, error)

func (Result) GetInterface

func (r Result) GetInterface(index int) (interface{}, error)

过时: 此方法只能用于v1.0.0，高版本中，如果值为int64,uint64类型，会导致获取的值不对 Deprecated: only can use in v1.0.0

func (Result) GetString

func (r Result) GetString(index int) (string, error)

func (Result) GetUint64

func (r Result) GetUint64(index int) (uint64, error)

func (Result) Gets

func (r Result) Gets(args ...interface{}) error

func (Result) IsFailure

func (r Result) IsFailure() bool

func (Result) IsFinish

func (r Result) IsFinish() bool

func (Result) IsSuccess

func (r Result) IsSuccess() bool

func (*Result) SetStatusRunning

func (r *Result) SetStatusRunning()