queue

Documentation

Index

• Constants
• type Message
• type MessageResult
• type MessageStatus
• type Queue
• type QueueOptions
• type ResultCallbackFunc

Constants

const (
	TaskQueuePrefix = "taskq"
)

Types

type Message

type Message struct {
	// 业务标识
	Id string

	//内部标识,内部自动生成
	InnerId string
	Name    string

	// the same Scheme for the same task handler
	Scheme string

	// Args is json format, for run task
	Args string
}

type MessageResult

type MessageResult struct {
	// 业务标识
	Id string

	//内部标识,内部自动生成
	InnerId string
	Name    string

	// the same Scheme for the same task handler
	Scheme string

	// Args is json format, for run task
	Result string

	Status MessageStatus

	Err error
}

type MessageStatus

type MessageStatus = string

const (
	MessageStatus_Unknown MessageStatus = "Status_Unknown"
	MessageStatus_Pending MessageStatus = "Status_Pending"
	MessageStatus_Success MessageStatus = "Status_Success"
	MessageStatus_Doing   MessageStatus = "Status_Doing"
	MessageStatus_Fail    MessageStatus = "Status_Fail"
)

type Queue

type Queue interface {
	Add(ctx context.Context, msg *Message) (string, error)
	FetchOne(ctx context.Context, waitTimeout time.Duration) (*Message, error)
	Delete(ctx context.Context, msg *Message) error

	AddResult(ctx context.Context, result *MessageResult, expired time.Duration) (string, error)
	FetchResult(ctx context.Context, key string) (*MessageResult, error)
}

type QueueOptions

type QueueOptions struct {
	Name string
}

type ResultCallbackFunc

type ResultCallbackFunc func(ctx context.Context, result *MessageResult)