kernel

Documentation

Index

• Constants
• type Context
  • func NewContext(ctx context.Context) *Context
  • func (c *Context) Put(key any, value any)
  • func (c *Context) Runtime(runtime time.Time)
• type Executor
• type Schedule
• type Selector
• type Status
• type Task
• type Tasker
• type Type

Constants

const (
	StatusCreated  = 1
	StatusRunning  = 2
	StatusRetrying = 3

	StatusFailed = 10

	StatusSuccess = 20
)

Types

type Context

type Context struct {
	context.Context
}

func NewContext

func NewContext(ctx context.Context) *Context

func (*Context) Put

func (c *Context) Put(key any, value any)

func (*Context) Runtime

func (c *Context) Runtime(runtime time.Time)

type Executor

type Executor interface {
	// Execute 执行任务
	Execute(ctx *Context, target uint64, times uint32) error
}

type Schedule

type Schedule interface {
	// Id 任务标识，如果不提供将自动生成
	Id() uint64

	// Target 目标
	Target() uint64

	// Timeout 任务超时时间
	Timeout() time.Duration

	// Type 类型
	Type() Type

	// Subtype 子类型
	Subtype() Type

	// Maximum 最大重试次数
	Maximum() uint32

	// Data 数据
	Data() map[string]any

	// Next 下一个可被执行的时间
	Next() time.Time
}

type Selector

type Selector interface {
	// Select 选择不同的执行器执行任务
	Select(Task) (Executor, error)
}

type Status

type Status uint8

type Task

type Task interface {
	Schedule

	// Times 当然运行次数
	Times() uint32
}

type Tasker

type Tasker interface {
	// Start 启动
	Start(ctx context.Context) error

	// Add 添加
	Add(schedule Schedule, schedules ...Schedule) error

	// Remove 删除
	Remove(schedule Schedule) error

	// Running 运行中
	Running(id uint64, status Status, times uint32) error

	// Update 修改
	Update(id uint64, status Status, runtime time.Time) error

	// Pop 取出任务并执行
	Pop() Task

	// Archive 存档
	Archive(task Task) error

	// Failed 执行错误
	Failed(task Task) error

	// Stop 停止
	Stop(ctx context.Context) error
}

type Type

type Type uint16

const (
	TypeCron Type = iota + 1
	TypeFixed
	TypeRate
	TypeComputable
	TypeOnce
)