cron

Documentation

Index

• Variables
• func AddJob(spec string, job *Job) bool
• func AddSYSJob(name string, fn RunnerGetter, example string, description string)
• func Close()
• func CmdParams(command string) []string
• func GetEntries(size int) []*cron.Entry
• func GetEntryById(id uint) *cron.Entry
• func HistoryJobsRunning() bool
• func InitJobs(ctx context.Context) error
• func Initial(sizes ...int)
• func InitialMailTpl()
• func MailTpl() *template.Template
• func MainCron(mustStart bool) *cron.Cron
• func NewCmdRec(max uint64) *cmdRec
• func Parse(spec string) error
• func RemoveJob(id uint)
• func Running() bool
• func SendMail(toEmail string, toUsername string, title string, content []byte, ...) error
• func SendMailWithID(id uint64, toEmail string, toUsername string, title string, content []byte, ...) error
• type EmailConfig
• type Job
  • func NewCommandJob(ctx context.Context, id uint, name string, command string, dir string, ...) *Job
  • func NewJobFromTask(ctx context.Context, task *dbschema.Task) (*Job, error)
  • func (j *Job) Id() uint
  • func (j *Job) LogData() *dbschema.TaskLog
  • func (j *Job) LogID() uint64
  • func (j *Job) Name() string
  • func (j *Job) Run()
  • func (j *Job) Status() int64
• type Jobx
• type OutputWriter
  • func NewOutputWriter(sizes ...uint64) OutputWriter
• type Runner
• type RunnerGetter

Variables

var (
	PoolSize           = 50                 //连接池容量
	DefaultSMTPConfig  = &mail.SMTPConfig{} //STMP配置
	DefaultEmailConfig = &EmailConfig{}
)

var (
	SYSJobs    = map[string]Jobx{}
	ErrFailure = errors.New(`Error`)
	//NotRecordPrefixFlag 不记录日志的前缀标识
	NotRecordPrefixFlag = `--/ignore/--`
)

var (
	ErrIncorrectRecipient = errors.New(`The recipient's email address is incorrect`)
)

Functions

func AddJob

func AddJob(spec string, job *Job) bool

func AddSYSJob

func AddSYSJob(name string, fn RunnerGetter, example string, description string)

func Close

func Close()

func CmdParams

func CmdParams(command string) []string

func GetEntries

func GetEntries(size int) []*cron.Entry

func GetEntryById

func GetEntryById(id uint) *cron.Entry

func HistoryJobsRunning

func HistoryJobsRunning() bool

func InitJobs

func InitJobs(ctx context.Context) error

func Initial

func Initial(sizes ...int)

func InitialMailTpl

func InitialMailTpl()

func MailTpl

func MailTpl() *template.Template

func MainCron

func MainCron(mustStart bool) *cron.Cron

func NewCmdRec

func NewCmdRec(max uint64) *cmdRec

func Parse

func Parse(spec string) error

func RemoveJob

func RemoveJob(id uint)

func Running

func Running() bool

func SendMail

func SendMail(toEmail string, toUsername string, title string, content []byte, ccList ...string) error

func SendMailWithID

func SendMailWithID(id uint64, toEmail string, toUsername string, title string, content []byte, ccList ...string) error

Types

type EmailConfig

type EmailConfig struct {
	Template  string
	Sender    string
	Engine    string
	Timeout   int64
	QueueSize int
}

type Job

type Job struct {
	Concurrent bool // 同一个任务是否允许并行执行
	// contains filtered or unexported fields
}

func NewCommandJob

func NewCommandJob(ctx context.Context, id uint, name string, command string, dir string, env ...string) *Job

func NewJobFromTask

func NewJobFromTask(ctx context.Context, task *dbschema.Task) (*Job, error)

func (*Job) Id

func (j *Job) Id() uint

func (*Job) LogData

func (j *Job) LogData() *dbschema.TaskLog

func (*Job) LogID

func (j *Job) LogID() uint64

func (*Job) Name

func (j *Job) Name() string

func (*Job) Run

func (j *Job) Run()

func (*Job) Status

func (j *Job) Status() int64

type Jobx

type Jobx struct {
	Example      string //">funcName:param"
	Description  string
	RunnerGetter RunnerGetter
}

type OutputWriter

type OutputWriter interface {
	io.Writer
	String() string
	Bytes() []byte
}

func NewOutputWriter

func NewOutputWriter(sizes ...uint64) OutputWriter

type Runner

type Runner func(timeout time.Duration) (out string, runingErr string, onRunErr error, isTimeout bool)

type RunnerGetter

type RunnerGetter func(string) Runner