gocron

package module
Version: v0.0.0-...-cdc2733 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 2, 2019 License: BSD-2-Clause Imports: 8 Imported by: 1

README

This package is currently looking for new maintainers (cause @jasonlvhit is in ICU). Please message @jasonlvhit if you are interested.

goCron: A Golang Job Scheduling Package.

GgoDoc Stories in Ready

goCron is a Golang job scheduling package which lets you run Go functions periodically at pre-determined interval using a simple, human-friendly syntax.

goCron is a Golang implementation of Ruby module clockwork and Python job scheduling package schedule, and personally, this package is my first Golang program, just for fun and practice.

See also this two great articles:

Back to this package, you could just use this simple API as below, to run a cron scheduler.

package main

import (
	"fmt"
	"github.com/jasonlvhit/gocron"
)

func task() {
	fmt.Println("I am runnning task.")
}

func taskWithParams(a int, b string) {
	fmt.Println(a, b)
}

func main() {
	// Do jobs with params
	gocron.Every(1).Second().Do(taskWithParams, 1, "hello")

	// Do jobs without params
	gocron.Every(1).Second().Do(task)
	gocron.Every(2).Seconds().Do(task)
	gocron.Every(1).Minute().Do(task)
	gocron.Every(2).Minutes().Do(task)
	gocron.Every(1).Hour().Do(task)
	gocron.Every(2).Hours().Do(task)
	gocron.Every(1).Day().Do(task)
	gocron.Every(2).Days().Do(task)

	// Do jobs on specific weekday
	gocron.Every(1).Monday().Do(task)
	gocron.Every(1).Thursday().Do(task)

	// function At() take a string like 'hour:min'
	gocron.Every(1).Day().At("10:30").Do(task)
	gocron.Every(1).Monday().At("18:30").Do(task)

	// remove, clear and next_run
	_, time := gocron.NextRun()
	fmt.Println(time)

	gocron.Remove(task)
	gocron.Clear()

	// function Start start all the pending jobs
	<- gocron.Start()

	// also , you can create a your new scheduler,
	// to run two scheduler concurrently
	s := gocron.NewScheduler()
	s.Every(3).Seconds().Do(task)
	<- s.Start()

}

and full test cases and document will be coming soon.

Once again, thanks to the great works of Ruby clockwork and Python schedule package. BSD license is used, see the file License for detail.

Have fun!

Documentation

Overview

Package gocron : A Golang Job Scheduling Package.

An in-process scheduler for periodic jobs that uses the builder pattern for configuration. Schedule lets you run Golang functions periodically at pre-determined intervals using a simple, human-friendly syntax.

Inspired by the Ruby module clockwork <https://github.com/tomykaira/clockwork> and Python package schedule <https://github.com/dbader/schedule>

See also http://adam.heroku.com/past/2010/4/13/rethinking_cron/ http://adam.heroku.com/past/2010/6/30/replace_cron_with_clockwork/

Copyright 2014 Jason Lyu. jasonlvhit@gmail.com . All rights reserved. Use of this source code is governed by a BSD-style . license that can be found in the LICENSE file.

Index

Constants

View Source
const MAXJOBNUM = 10000

MAXJOBNUM max number of jobs, hack it if you need.

Variables

This section is empty.

Functions

func ChangeLoc

func ChangeLoc(newLocation *time.Location)

ChangeLoc change default the time location

func Clear

func Clear()

Clear all scheduled jobs

func Remove

func Remove(j interface{})

Remove specific job

func RunAll

func RunAll()

RunAll run all jobs regardless if they are scheduled to run or not.

func RunAllwithDelay

func RunAllwithDelay(d int)

RunAllwithDelay run all the jobs with a delay in seconds

A delay of `delay` seconds is added between each job. This can help to distribute the system load generated by the jobs more evenly over time.

func RunPending

func RunPending()

RunPending run all jobs that are scheduled to run

Please note that it is *intended behavior that run_pending() does not run missed jobs*. For example, if you've registered a job that should run every minute and you only call run_pending() in one hour increments then your job won't be run 60 times in between but only once.

func Scheduled

func Scheduled(j interface{}) bool

Check if specific job j was already added

func Start

func Start() chan bool

Start run all jobs that are scheduled to run

Types

type Job

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

Job struct keeping information about job

func Every

func Every(interval uint64) *Job

Every schedules a new periodic job running in specific interval

func NewJob

func NewJob(interval uint64) *Job

NewJob creates a new job with the time interval.

func NextRun

func NextRun() (job *Job, time time.Time)

NextRun gets the next running time

func (*Job) At

func (j *Job) At(t string) *Job

At schedules job at specific time of day

s.Every(1).Day().At("10:30").Do(task)
s.Every(1).Monday().At("10:30").Do(task)

func (*Job) Day

func (j *Job) Day() *Job

Day set the job's unit with day, which interval is 1

func (*Job) Days

func (j *Job) Days() *Job

Days set the job's unit with days

func (*Job) Do

func (j *Job) Do(jobFun interface{}, params ...interface{})

Do specifies the jobFunc that should be called every time the job runs

func (*Job) Friday

func (j *Job) Friday() *Job

Friday sets the job start day Friday

func (*Job) Hour

func (j *Job) Hour() *Job

Hour set the unit with hour, which interval is 1

func (*Job) Hours

func (j *Job) Hours() *Job

Hours set the unit with hours

func (*Job) Minute

func (j *Job) Minute() *Job

Minute set the unit with minute, which interval is 1

func (*Job) Minutes

func (j *Job) Minutes() *Job

Minutes set the unit with minute

func (*Job) Monday

func (j *Job) Monday() (job *Job)

Monday set the start day with Monday - s.Every(1).Monday().Do(task)

func (*Job) NextScheduledTime

func (j *Job) NextScheduledTime() time.Time

NextScheduledTime returns the time of when this job is to run next

func (*Job) Saturday

func (j *Job) Saturday() *Job

Saturday sets the job start day Saturday

func (*Job) Second

func (j *Job) Second() *Job

Second set the unit with second

func (*Job) Seconds

func (j *Job) Seconds() *Job

Seconds set the unit with seconds

func (*Job) Sunday

func (j *Job) Sunday() *Job

Sunday sets the job start day Sunday

func (*Job) Thursday

func (j *Job) Thursday() *Job

Thursday sets the job start day Thursday

func (*Job) Tuesday

func (j *Job) Tuesday() *Job

Tuesday sets the job start day Tuesday

func (*Job) Wednesday

func (j *Job) Wednesday() *Job

Wednesday sets the job start day Wednesday

func (*Job) Weekday

func (j *Job) Weekday(startDay time.Weekday) *Job

Weekday start job on specific Weekday

func (*Job) Weeks

func (j *Job) Weeks() *Job

Weeks sets the units as weeks

type Scheduler

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

Scheduler struct, the only data member is the list of jobs. - implements the sort.Interface{} for sorting jobs, by the time nextRun

func NewScheduler

func NewScheduler() *Scheduler

NewScheduler creates a new scheduler

func (*Scheduler) Clear

func (s *Scheduler) Clear()

Clear delete all scheduled jobs

func (*Scheduler) Every

func (s *Scheduler) Every(interval uint64) *Job

Every schedule a new periodic job with interval

func (*Scheduler) Len

func (s *Scheduler) Len() int

func (*Scheduler) Less

func (s *Scheduler) Less(i, j int) bool

func (*Scheduler) NextRun

func (s *Scheduler) NextRun() (*Job, time.Time)

NextRun datetime when the next job should run.

func (*Scheduler) Remove

func (s *Scheduler) Remove(j interface{})

Remove specific job j

func (*Scheduler) RunAll

func (s *Scheduler) RunAll()

RunAll run all jobs regardless if they are scheduled to run or not

func (*Scheduler) RunAllwithDelay

func (s *Scheduler) RunAllwithDelay(d int)

RunAllwithDelay runs all jobs with delay seconds

func (*Scheduler) RunPending

func (s *Scheduler) RunPending()

RunPending runs all the jobs that are scheduled to run.

func (*Scheduler) Scheduled

func (s *Scheduler) Scheduled(j interface{}) bool

Check if specific job j was already added

func (*Scheduler) Start

func (s *Scheduler) Start() chan bool

Start all the pending jobs Add seconds ticker

func (*Scheduler) Swap

func (s *Scheduler) Swap(i, j int)

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL