scheduler

Documentation

Index

• type CronScheduler
  • func NewCronScheduler() *CronScheduler
  • func (lct *CronScheduler) Schedule(spec interface{}, job func()) (id interface{}, err error)
  • func (lct *CronScheduler) Start()
  • func (lct *CronScheduler) Stop()
  • func (lct *CronScheduler) Unschedule(id interface{}) error
• type Scheduler

Types

type CronScheduler

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

CronScheduler implements scheduler using a cron-like schedule spec syntax.

func NewCronScheduler

func NewCronScheduler() *CronScheduler

NewCronScheduler returns a new CronScheduler instance.

func (*CronScheduler) Schedule

func (lct *CronScheduler) Schedule(spec interface{}, job func()) (id interface{}, err error)

func (*CronScheduler) Start

func (lct *CronScheduler) Start()

func (*CronScheduler) Stop

func (lct *CronScheduler) Stop()

func (*CronScheduler) Unschedule

func (lct *CronScheduler) Unschedule(id interface{}) error

type Scheduler

type Scheduler interface {

	// Schedule a new job with the given scheduling spec.
	// Returns a unique identifier of the scheduled job.
	Schedule(spec interface{}, job func()) (id interface{}, err error)

	// Unschedule removes a given job from the scheduler.
	Unschedule(id interface{}) error

	// Start runs the scheduler cycle.
	Start()

	// Stop stops the scheduler cycle.
	Stop()
}

Scheduler defines a simple timed task scheduler to execute jobs at given times or intervals.