kcron

Documentation

Index

• type JobWrapper
  • func (job JobWrapper) Run()
• type Kcron
  • func New(option ...*Option) (k *Kcron, err error)
  • func (d *Kcron) AddFunc(jobName, cronStr string, cmd func()) (err error)
  • func (d *Kcron) AddJob(jobName, cronStr string, job cron.Job) (err error)
  • func (d *Kcron) Remove(jobName string)
  • func (d *Kcron) Run() error
  • func (d *Kcron) Stop() error
• type NodePool
  • func (np *NodePool) InitPoolGrabService()
  • func (np *NodePool) PickNodeByJobName(jobName string) string
• type Option
  • func NewOption() *Option
  • func SetDriver(d driver.Driver) *Option
  • func SetLogger(l baselogger.KcronLogger) *Option
  • func SetWorkerName(s string) *Option
  • func (c *Option) MergeOption(opts ...*Option) *Option
  • func (c *Option) SetDriver(d driver.Driver) *Option
  • func (c *Option) SetLogger(l baselogger.KcronLogger) *Option
  • func (c *Option) SetWorkerName(s string) *Option

Types

type JobWrapper

type JobWrapper struct {
	ID      cron.EntryID
	Kcron   *Kcron
	Name    string
	CronStr string
	Func    func()
	Job     cron.Job
}

JobWarpper is a job warpper

func (JobWrapper) Run

func (job JobWrapper) Run()

Run is run job

type Kcron

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

Kcron is main struct

func New

func New(option ...*Option) (k *Kcron, err error)

NewKcron create a Kcron

func (*Kcron) AddFunc

func (d *Kcron) AddFunc(jobName, cronStr string, cmd func()) (err error)

AddFunc add a cron func

func (*Kcron) AddJob

func (d *Kcron) AddJob(jobName, cronStr string, job cron.Job) (err error)

AddJob add a job

func (*Kcron) Remove

func (d *Kcron) Remove(jobName string)

Remove Job

func (*Kcron) Run

func (d *Kcron) Run() error

Start start job

func (*Kcron) Stop

func (d *Kcron) Stop() error

Stop stop job

type NodePool

type NodePool struct {
	NodeID string

	Driver driver.Driver
	// contains filtered or unexported fields
}

NodePool is a node pool

func (*NodePool) InitPoolGrabService

func (np *NodePool) InitPoolGrabService()

func (*NodePool) PickNodeByJobName

func (np *NodePool) PickNodeByJobName(jobName string) string

PickNodeByJobName : 使用一致性hash算法根据任务名获取一个执行节点

type Option

type Option struct {
	WorkerName string
	Driver     driver.Driver
	Logger     baselogger.KcronLogger
}

func NewOption

func NewOption() *Option

func SetDriver

func SetDriver(d driver.Driver) *Option

func SetLogger

func SetLogger(l baselogger.KcronLogger) *Option

func SetWorkerName

func SetWorkerName(s string) *Option

func (*Option) MergeOption

func (c *Option) MergeOption(opts ...*Option) *Option

func (*Option) SetDriver

func (c *Option) SetDriver(d driver.Driver) *Option

func (*Option) SetLogger

func (c *Option) SetLogger(l baselogger.KcronLogger) *Option

func (*Option) SetWorkerName

func (c *Option) SetWorkerName(s string) *Option