cron

Documentation

Index

• Variables
• func AddTask(taskname string, t Tasker)
• func DeleteTask(taskname string)
• func RegisterPipeTask(pi pipeInterface, spec string, runInRest ...bool)
• func RegisterTask(task taskInterface, spec string, runInRest ...bool) *cron
• func StartCronTasks()
• func StartTask()
• func StopCronTasks()
• func StopTask()
• type CronTask
  • func (t *CronTask) GetName() string
  • func (t *CronTask) IsEnableTx() bool
  • func (t *CronTask) Run(taskContext *TaskContext)
  • func (t *CronTask) SetName(name string)
• type MapSorter
  • func NewMapSorter(m map[string]Tasker) *MapSorter
  • func (ms *MapSorter) Len() int
  • func (ms *MapSorter) Less(i, j int) bool
  • func (ms *MapSorter) Sort()
  • func (ms *MapSorter) Swap(i, j int)
• type Pipe
  • func (p *Pipe) AddData(data interface{}) error
  • func (p *Pipe) EnableParallel() bool
  • func (p *Pipe) GetCap() int
  • func (p *Pipe) GetConsumerCount() int
  • func (p *Pipe) GetData() interface{}
  • func (p *Pipe) Init(cap int)
  • func (p *Pipe) RunConsumer(data interface{}, taskCtx *TaskContext)
• type Schedule
  • func (s *Schedule) Next(t time.Time) time.Time
• type Task
  • func NewTask(tname string, spec string, f TaskFunc) *Task
  • func (t *Task) GetNext() time.Time
  • func (t *Task) GetPrev() time.Time
  • func (t *Task) GetSpec() string
  • func (t *Task) GetStatus() string
  • func (t *Task) Run() error
  • func (t *Task) SetCron(spec string)
  • func (t *Task) SetNext(now time.Time)
  • func (t *Task) SetPrev(now time.Time)
• type TaskContext
  • func (this *TaskContext) GetCtx() context.Context
  • func (this *TaskContext) GetDb() *gorm.DB
  • func (this *TaskContext) Init(ctx context.Context, db *gorm.DB)
  • func (this *TaskContext) SetCtx(ctx context.Context)
• type TaskFunc
• type Tasker

Variables

var (
	AdminTaskList map[string]Tasker
)

The bounds for each field.

Functions

func AddTask

func AddTask(taskname string, t Tasker)

AddTask add task with name

func DeleteTask

func DeleteTask(taskname string)

DeleteTask delete task with name

func RegisterPipeTask

func RegisterPipeTask(pi pipeInterface, spec string, runInRest ...bool)

func RegisterTask

func RegisterTask(task taskInterface, spec string, runInRest ...bool) *cron

func StartCronTasks

func StartCronTasks()

func StartTask

func StartTask()

StartTask start all tasks

func StopCronTasks

func StopCronTasks()

func StopTask

func StopTask()

StopTask stop all tasks

Types

type CronTask

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

func (*CronTask) GetName

func (t *CronTask) GetName() string

func (*CronTask) IsEnableTx

func (t *CronTask) IsEnableTx() bool

func (*CronTask) Run

func (t *CronTask) Run(taskContext *TaskContext)

func (*CronTask) SetName

func (t *CronTask) SetName(name string)

type MapSorter

type MapSorter struct {
	Keys []string
	Vals []Tasker
}

MapSorter sort map for tasker

func NewMapSorter

func NewMapSorter(m map[string]Tasker) *MapSorter

NewMapSorter create new tasker map

func (*MapSorter) Len

func (ms *MapSorter) Len() int

func (*MapSorter) Less

func (ms *MapSorter) Less(i, j int) bool

func (*MapSorter) Sort

func (ms *MapSorter) Sort()

Sort sort tasker map

func (*MapSorter) Swap

func (ms *MapSorter) Swap(i, j int)

type Pipe

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

func (*Pipe) AddData

func (p *Pipe) AddData(data interface{}) error

func (*Pipe) EnableParallel

func (p *Pipe) EnableParallel() bool

EnableParallel 启用并行，默认启用

func (*Pipe) GetCap

func (p *Pipe) GetCap() int

func (*Pipe) GetConsumerCount

func (p *Pipe) GetConsumerCount() int

GetConsumerCount 消费者数量 默认为通道容量十分之一

func (*Pipe) GetData

func (p *Pipe) GetData() interface{}

func (*Pipe) Init

func (p *Pipe) Init(cap int)

func (*Pipe) RunConsumer

func (p *Pipe) RunConsumer(data interface{}, taskCtx *TaskContext)

type Schedule

type Schedule struct {
	Second uint64
	Minute uint64
	Hour   uint64
	Day    uint64
	Month  uint64
	Week   uint64
}

Schedule time taks schedule

func (*Schedule) Next

func (s *Schedule) Next(t time.Time) time.Time

Next set schedule to next time

type Task

type Task struct {
	Taskname string
	Spec     *Schedule
	SpecStr  string
	DoFunc   TaskFunc
	Prev     time.Time
	Next     time.Time
	Errlist  []*taskerr // like errtime:errinfo
	ErrLimit int        // max length for the errlist, 0 stand for no limit
}

Task task struct

func NewTask

func NewTask(tname string, spec string, f TaskFunc) *Task

NewTask add new task with name, time and func

func (*Task) GetNext

func (t *Task) GetNext() time.Time

GetNext get the next call time of this task

func (*Task) GetPrev

func (t *Task) GetPrev() time.Time

GetPrev get prev time of this task

func (*Task) GetSpec

func (t *Task) GetSpec() string

GetSpec get spec string

func (*Task) GetStatus

func (t *Task) GetStatus() string

GetStatus get current task status

func (*Task) Run

func (t *Task) Run() error

Run run all tasks

func (*Task) SetCron

func (t *Task) SetCron(spec string)

SetCron some signals：

*： any time
,：　 separate signal

　　 －：duration

/n : do as n times of time duration

///////////////////////////////////////////////////////

0/30 * * * * *                        every 30s
0 43 21 * * *                         21:43
0 15 05 * * * 　　                     05:15
0 0 17 * * *                          17:00
0 0 17 * * 1                           17:00 in every Monday
0 0,10 17 * * 0,2,3                   17:00 and 17:10 in every Sunday, Tuesday and Wednesday
0 0-10 17 1 * *                       17:00 to 17:10 in 1 min duration each time on the first day of month
0 0 0 1,15 * 1                        0:00 on the 1st day and 15th day of month
0 42 4 1 * * 　 　                     4:42 on the 1st day of month
0 0 21 * * 1-6　　                     21:00 from Monday to Saturday
0 0,10,20,30,40,50 * * * *　           every 10 min duration
0 */10 * * * * 　　　　　　              every 10 min duration
0 * 1 * * *　　　　　　　　               1:00 to 1:59 in 1 min duration each time
0 0 1 * * *　　　　　　　　               1:00
0 0 */1 * * *　　　　　　　               0 min of hour in 1 hour duration
0 0 * * * *　　　　　　　　               0 min of hour in 1 hour duration
0 2 8-20/3 * * *　　　　　　             8:02, 11:02, 14:02, 17:02, 20:02
0 30 5 1,15 * *　　　　　　              5:30 on the 1st day and 15th day of month

func (*Task) SetNext

func (t *Task) SetNext(now time.Time)

SetNext set next time for this task

func (*Task) SetPrev

func (t *Task) SetPrev(now time.Time)

SetPrev set prev time of this task

type TaskContext

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

func (*TaskContext) GetCtx

func (this *TaskContext) GetCtx() context.Context

func (*TaskContext) GetDb

func (this *TaskContext) GetDb() *gorm.DB

func (*TaskContext) Init

func (this *TaskContext) Init(ctx context.Context, db *gorm.DB)

func (*TaskContext) SetCtx

func (this *TaskContext) SetCtx(ctx context.Context)

type TaskFunc

type TaskFunc func() error

TaskFunc task func type

type Tasker

type Tasker interface {
	GetSpec() string
	GetStatus() string
	Run() error
	SetNext(time.Time)
	GetNext() time.Time
	SetPrev(time.Time)
	GetPrev() time.Time
}

Tasker task interface