This fork is about adding some functionalities, that the original, excellent [project](github.com/mileusna/crontab) by [mileusna](github.com/mileusna) does not have yet:
* re-scheduling running jobs: by using `AddNamedJob` again
* stopping running jobs: by using `RemoveJob`
The rest of the README below directly comes from the original [repo](github.com/mileusna/crontab) by [mileusna](github.com/mileusna).
This package provides crontab tickers to golang apps, supporting crontab-like syntax like * * * * *
or */2 * * * *
etc.
go get github.com/mileusna/crontab
package main
import (
"fmt"
"log"
"github.com/mileusna/crontab"
)
func main() {
ctab := crontab.New() // create cron table
// AddJob and test the errors
err := ctab.AddJob("0 12 1 * *", myFunc) // on 1st day of month
if err != nil {
log.Println(err)
return
}
// MustAddJob is like AddJob but panics on wrong syntax or problems with func/args
// This aproach is similar to regexp.Compile and regexp.MustCompile from go's standard library, used for easier initialization on startup
ctab.MustAddJob("* * * * *", myFunc) // every minute
ctab.MustAddJob("0 12 * * *", myFunc3) // noon lauch
// fn with args
ctab.MustAddJob("0 0 * * 1,2", myFunc2, "Monday and Tuesday midnight", 123)
ctab.MustAddJob("*/5 * * * *", myFunc2, "every five min", 0)
// all your other app code as usual, or put sleep timer for demo
// time.Sleep(10 * time.Minute)
}
func myFunc() {
fmt.Println("Helo, world")
}
func myFunc3() {
fmt.Println("Noon!")
}
func myFunc2(s string, n int) {
fmt.Println("We have params here, string", s, "and number", n)
}
If you are not faimiliar with crontab syntax you might be better off with other packages for scheduling tasks. But if you are familiar with Linux and crontab, this package might be right for you.
Here are the few quick references about crontab simple but powerful syntax.
* * * * *
^ ^ ^ ^ ^
| | | | |
| | | | +----- day of week (0-6) (Sunday=0)
| | | +------- month (1-12)
| | +--------- day of month (1-31)
| +----------- hour (0-23)
+------------- min (0-59)
* * * * *
run on every minute10 * * * *
run at 0:10, 1:10 etc10 15 * * *
run at 15:10 every day* * 1 * *
run on every minute on 1st day of month0 0 1 1 *
Happy new year schedule0 0 * * 1
Run at midnight on every Monday
* 10,15,19 * * *
run at 10:00, 15:00 and 19:001-15 * * * *
run at 1, 2, 3...15 minute of each hour0 0-5,10 * * *
run on every hour from 0-5 and in 10 oclock
*/2 * * * *
run every two minutes10 */3 * * *
run every 3 hours on 10th min0 12 */2 * *
run at noon on every two days1-59/2 * * *
run every two minutes, but on odd minutes
There is no way to reschedule or to remove single job from crontab during runtime with crontab package. (Re)create new instance of crontab or use crontab.Clear()
function and then add jobs again to reschedule during runtime.