cron

README

Golang Cron

Cron Expression

The reference documentation is found at https://en.wikipedia.org/wiki/Cron#CRON_expression

Field name     Mandatory   Allowed values    Allowed special characters
----------     ----------   --------------    --------------------------
Seconds        No           0-59              * / , -
Minutes        Yes          0-59              * / , -
Hours          Yes          0-23              * / , -
Day of month   Yes          1-31              * / , - L W
Month          Yes          1-12 or JAN-DEC   * / , -
Day of week    Yes          0-6 or SUN-SAT    * / , - L #
Year           No           1970–2099         * / , -

Install

    go get -u github.com/flyaways/cron

Usage

package main

import (
	"fmt"
	"time"

	"github.com/flyaways/cron"
)

type task struct {
	cron.Job
	id   string
	expr string
}

func (t *task) Run() {
	fmt.Println(time.Now().Format(time.RFC3339Nano))
}

func (t *task) ID() string {
	return t.id
}

func (t *task) Cronexpr() string {
	return t.expr
}

func main() {
	c := cron.New()
	c.Start()

	c.Add(&task{
		id:   "AF0783D4-D16A-4CAE-8866-4E0648AE3651",
		expr: "0/2 * * * * ?",
	})
	time.Sleep(time.Second * 10)

	c.Update(&task{
		id:   "AF0783D4-D16A-4CAE-8866-4E0648AE3651",
		expr: "0/5 * * * * ?",
	})
	time.Sleep(time.Second * 10)

	c.Del(&task{
		id: "AF0783D4-D16A-4CAE-8866-4E0648AE3651",
	})
	time.Sleep(time.Second * 10)

	c.Stop()
}

Reference

• github.com/gorhill/cronexpr
• github.com/robfig/cron

License

• Apache License 2.0

Documentation

Index

• Variables
• type Daemon
  • func New() *Daemon
  • func NewWithLocation(location *time.Location) *Daemon
  • func (c *Daemon) Add(j Job) error
  • func (c *Daemon) Del(j Job) error
  • func (c *Daemon) SnapShot() Schedules
  • func (c *Daemon) Start()
  • func (c *Daemon) Stop()
  • func (c *Daemon) Update(j Job) error
• type Job
• type Schedule
• type Schedules
  • func (s Schedules) Len() int
  • func (s Schedules) Less(i, j int) bool
  • func (s Schedules) Pos(id string) int
  • func (s Schedules) Swap(i, j int)

Variables

var (
	ErrJobIDNotExists = errors.New("job id not exits")
	ErrJobIDExists    = errors.New("job id exists")
)

Types

type Daemon

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

func New

func New() *Daemon

func NewWithLocation

func NewWithLocation(location *time.Location) *Daemon

func (*Daemon) Add

func (c *Daemon) Add(j Job) error

func (*Daemon) Del

func (c *Daemon) Del(j Job) error

func (*Daemon) SnapShot

func (c *Daemon) SnapShot() Schedules

func (*Daemon) Start

func (c *Daemon) Start()

func (*Daemon) Stop

func (c *Daemon) Stop()

func (*Daemon) Update

func (c *Daemon) Update(j Job) error

type Job

type Job interface {
	Run()
	ID() string
	Cronexpr() string
}

type Schedule

type Schedule struct {
	Expression *cronexpr.Expression
	Next       time.Time
	Prev       time.Time
	Job
}

type Schedules

type Schedules []*Schedule

func (Schedules) Len

func (s Schedules) Len() int

func (Schedules) Less

func (s Schedules) Less(i, j int) bool

func (Schedules) Pos

func (s Schedules) Pos(id string) int

func (Schedules) Swap

func (s Schedules) Swap(i, j int)