structs

Documentation

Index

• func EncodeTaskMessage(msg *TaskMessage) (string, error)
• type ServerInfo
• type ServerStatus
  • func NewServerStatus(v ServerStatusValue) *ServerStatus
  • func (s *ServerStatus) Get() ServerStatusValue
  • func (s *ServerStatus) Set(v ServerStatusValue)
  • func (s *ServerStatus) String() string
• type ServerStatusValue
• type TaskMessage
  • func DocodeTaskMessage(s string) (*TaskMessage, error)
• type TaskMessageType
  • func (tt TaskMessageType) String() string
• type WorkerInfo

Functions

func EncodeTaskMessage

func EncodeTaskMessage(msg *TaskMessage) (string, error)

Types

type ServerInfo

type ServerInfo struct {
}

type ServerStatus

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

ServerStatus represents status of a server. It is concurrency safe.

func NewServerStatus

func NewServerStatus(v ServerStatusValue) *ServerStatus

NewServerStatus returns a new status instance given an initial value.

func (*ServerStatus) Get

func (s *ServerStatus) Get() ServerStatusValue

Get returns the status value.

func (*ServerStatus) Set

func (s *ServerStatus) Set(v ServerStatusValue)

Set sets the status value.

func (*ServerStatus) String

func (s *ServerStatus) String() string

type ServerStatusValue

type ServerStatusValue int

const (
	// StatusIdle indicates the server is in idle state.
	StatusIdle ServerStatusValue = iota

	// StatusRunning indicates the server is up and active.
	StatusRunning

	// StatusQuiet indicates the server is up but not active.
	StatusQuiet

	// StatusStopped indicates the server server has been stopped.
	StatusStopped
)

type TaskMessage

type TaskMessage struct {
	// 唯一ID
	ID uuid.UUID

	// 此 task 所在的 queue 名称，可以不指定，此时会使用默认值 `default`
	// 这个字段的作用是给这个任务起一个名字，相当于 namespace。常见的场景是，当我们想停掉某个任务时，传入对应的名字就能区分
	QueueName string

	// task 类型
	Type TaskMessageType

	// 唯一标识这个 msg
	UniqueKey string

	// 剩余重试次数
	CanRetry int

	// 上一次失败时的错误
	LastErrMsg error

	// 每次执行的 timeout，单位为 s。0 表示没有超时时间
	Timeout int64

	//
	Deadline int64

	// 这个 task 中存储的数据
	Payload map[string]interface{}
}

func DocodeTaskMessage

func DocodeTaskMessage(s string) (*TaskMessage, error)

type TaskMessageType

type TaskMessageType string

func (TaskMessageType) String

func (tt TaskMessageType) String() string

type WorkerInfo

type WorkerInfo struct {
}