cron

Documentation

Index

• type ConstantDelaySchedule
  • func Every(duration time.Duration) ConstantDelaySchedule
  • func (schedule ConstantDelaySchedule) Next(t time.Time) time.Time
• type Cron
  • func InitCrontab(g *gin.Engine) (c *Cron)
  • func New(engine *gin.Engine) *Cron
  • func NewWithLocation(location *time.Location, engine *gin.Engine) *Cron
  • func (c *Cron) AddAfterRun(afterRun func(*gin.Context)) *Cron
  • func (c *Cron) AddBeforeRun(beforeRun func(*gin.Context) bool) *Cron
  • func (c *Cron) AddFunc(spec string, cmd func(*gin.Context) error) error
  • func (c *Cron) AddJob(spec string, cmd Job) error
  • func (c *Cron) Entries() []*Entry
  • func (c *Cron) Location() *time.Location
  • func (c *Cron) Run()
  • func (c *Cron) Schedule(spec string, schedule Schedule, cmd Job)
  • func (c *Cron) Start()
  • func (c *Cron) Stop()
• type Entry
• type FuncJob
  • func (f FuncJob) Run(ctx *gin.Context) error
• type Job
• type ParseOption
• type Parser
  • func NewParser(options ParseOption) Parser
  • func (p Parser) Parse(spec string) (Schedule, error)
• type Schedule
  • func Parse(spec string) (Schedule, error)
  • func ParseStandard(standardSpec string) (Schedule, error)
• type SpecSchedule
  • func (s *SpecSchedule) Next(t time.Time) time.Time

Types

type ConstantDelaySchedule

type ConstantDelaySchedule struct {
	Delay time.Duration
}

ConstantDelaySchedule represents a simple recurring duty cycle, e.g. "Every 5 minutes". It does not support jobs more frequent than once a second.

func Every

func Every(duration time.Duration) ConstantDelaySchedule

Every returns a crontab Schedule that activates once every duration. Delays of less than a second are not supported (will round up to 1 second). Any fields less than a Second are truncated.

func (ConstantDelaySchedule) Next

func (schedule ConstantDelaySchedule) Next(t time.Time) time.Time

Next returns the next time this should be run. This rounds so that the next activation time will be on the second.

type Cron

type Cron struct {
	ErrorLog *log.Logger
	// contains filtered or unexported fields
}

Cron keeps track of any number of entries, invoking the associated func as specified by the schedule. It may be started, stopped, and the entries may be inspected while running.

func InitCrontab

func InitCrontab(g *gin.Engine) (c *Cron)

func New

func New(engine *gin.Engine) *Cron

New returns a new Cron job runner, in the Local time zone.

func NewWithLocation

func NewWithLocation(location *time.Location, engine *gin.Engine) *Cron

NewWithLocation returns a new Cron job runner.

func (*Cron) AddAfterRun

func (c *Cron) AddAfterRun(afterRun func(*gin.Context)) *Cron

add cron after func

func (*Cron) AddBeforeRun

func (c *Cron) AddBeforeRun(beforeRun func(*gin.Context) bool) *Cron

add cron before func

func (*Cron) AddFunc

func (c *Cron) AddFunc(spec string, cmd func(*gin.Context) error) error

AddFunc adds a func to the Cron to be run on the given schedule.

func (*Cron) AddJob

func (c *Cron) AddJob(spec string, cmd Job) error

AddJob adds a Job to the Cron to be run on the given schedule.

func (*Cron) Entries

func (c *Cron) Entries() []*Entry

Entries returns a snapshot of the cron entries.

func (*Cron) Location

func (c *Cron) Location() *time.Location

Location gets the time zone location

func (*Cron) Run

func (c *Cron) Run()

Run the cron scheduler, or no-op if already running.

func (*Cron) Schedule

func (c *Cron) Schedule(spec string, schedule Schedule, cmd Job)

Schedule adds a Job to the Cron to be run on the given schedule.

func (*Cron) Start

func (c *Cron) Start()

Start the cron scheduler in its own go-routine, or no-op if already started.

func (*Cron) Stop

func (c *Cron) Stop()

Stop stops the cron scheduler if it is running; otherwise it does nothing.

type Entry

type Entry struct {
	// The schedule on which this job should be run.
	Schedule Schedule

	// The next time the job will run. This is the zero time if Cron has not been
	// started or this entry's schedule is unsatisfiable
	Next time.Time

	// The last time this job was run. This is the zero time if the job has never
	// been run.
	Prev time.Time

	// The Job to run.
	Job Job

	//spec
	Spec string
}

Entry consists of a schedule and the func to execute on that schedule.

type FuncJob

type FuncJob func(*gin.Context) error

A wrapper that turns a func() into a cron.Job

func (FuncJob) Run

func (f FuncJob) Run(ctx *gin.Context) error

type Job

type Job interface {
	Run(ctx *gin.Context) error
}

Job is an interface for submitted cron jobs.

type ParseOption

type ParseOption int

Configuration options for creating a parser. Most options specify which fields should be included, while others enable features. If a field is not included the parser will assume a default value. These options do not change the order fields are parse in.

const (
	Second      ParseOption = 1 << iota // Seconds field, default 0
	Minute                              // Minutes field, default 0
	Hour                                // Hours field, default 0
	Dom                                 // Day of month field, default *
	Month                               // Month field, default *
	Dow                                 // Day of week field, default *
	DowOptional                         // Optional day of week field, default *
	Descriptor                          // Allow descriptors such as @monthly, @weekly, etc.
)

type Parser

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

A custom Parser that can be configured.

func NewParser

func NewParser(options ParseOption) Parser

Creates a custom Parser with custom options.

// Standard parser without descriptors
specParser := NewParser(Minute | Hour | Dom | Month | Dow)
sched, err := specParser.Parse("0 0 15 */3 *")

// Same as above, just excludes time fields
subsParser := NewParser(Dom | Month | Dow)
sched, err := specParser.Parse("15 */3 *")

// Same as above, just makes Dow optional
subsParser := NewParser(Dom | Month | DowOptional)
sched, err := specParser.Parse("15 */3")

func (Parser) Parse

func (p Parser) Parse(spec string) (Schedule, error)

Parse returns a new crontab schedule representing the given spec. It returns a descriptive error if the spec is not valid. It accepts crontab specs and features configured by NewParser.

type Schedule

type Schedule interface {
	// Return the next activation time, later than the given time.
	// Next is invoked initially, and then each time the job is run.
	Next(time.Time) time.Time
}

The Schedule describes a job's duty cycle.

func Parse

func Parse(spec string) (Schedule, error)

Parse returns a new crontab schedule representing the given spec. It returns a descriptive error if the spec is not valid.

It accepts

• Full crontab specs, e.g. "* * * * * ?"
• Descriptors, e.g. "@midnight", "@every 1h30m"

func ParseStandard

func ParseStandard(standardSpec string) (Schedule, error)

ParseStandard returns a new crontab schedule representing the given standardSpec (https://en.wikipedia.org/wiki/Cron). It differs from Parse requiring to always pass 5 entries representing: minute, hour, day of month, month and day of week, in that order. It returns a descriptive error if the spec is not valid.

It accepts

• Standard crontab specs, e.g. "* * * * ?"
• Descriptors, e.g. "@midnight", "@every 1h30m"

type SpecSchedule

type SpecSchedule struct {
	Second, Minute, Hour, Dom, Month, Dow uint64
}

SpecSchedule specifies a duty cycle (to the second granularity), based on a traditional crontab specification. It is computed initially and stored as bit sets.

func (*SpecSchedule) Next

func (s *SpecSchedule) Next(t time.Time) time.Time

Next returns the next time this schedule is activated, greater than the given time. If no time can be found to satisfy the schedule, return the zero time.