go-quartz

README

go-quartz

A go scheduling library

About

Inspired by quartz java scheduler.

Library building blocks

Job interface. Should be implemented by custom jobs for further scheduling

type Job interface {
	Execute()
	Description() string
	Key() int
}

Scheduler interface

type Scheduler interface {
	//start scheduler
	Start()
	//schedule Job with given Trigger
	ScheduleJob(job Job, trigger Trigger) error
	//get all scheduled Job keys
	GetJobKeys() []int
	//get scheduled Job metadata
	GetScheduledJob(key int) (*ScheduledJob, error)
	//remove Job from execution queue
	DeleteJob(key int) error
	//clear all scheduled jobs
	Clear()
	//shutdown scheduler
	Stop()
}

Implemented Schedulers

• StdScheduler

Trigger interface

type Trigger interface {
	NextFireTime(prev int64) (int64, error)
	Description() string
}

Implemented Triggers

• CronTrigger
• SimpleTrigger
• RunOnceTrigger

Examples

Could be found in examples directory.

License

Licensed under the MIT License.