README.md

hardloop

Hardloop is a cron time-based function runner.

Set start and end times as cron specs, and give function to run between them.

go get github.com/worldline-go/hardloop

Usage

Check the https://crontab.guru/ to explain about cron specs.

Hardloop different works than crontab.guru in weekdays and day of month selection. We use and operation but that site use or operation when used both of them.

You can give as much as you want start, stop times.

If stop time is not given, it will run forever.

If just stop time given, it will restart in the stop times.

Use Timezone to set the timezone: CRON_TZ=Europe/Istanbul 0 7 * * 1,2,3,4,5

Default timezone is system timezone.

Some times doens't exist in some timezones. For example, CRON_TZ=Europe/Amsterdam 30 2 26 3 * doesn't exist due to in that time 02:00 -> 03:00 DST 1 hour adding. It will be make some problems so don't use non-exist times.

// Set start cron specs.
startSpecs := []string{
    // start at 7:00 in Monday, Tuesday, Wednesday, Thursday, Friday
    "0 7 * * 1,2,3,4,5",
    // start at 9:00 in Saturday
    "0 9 * * 6",
}
// Set stop cron specs.
stopSpecs := []string{
    // stop at 17:00 in Monday, Tuesday, Wednesday, Thursday, Friday
    "0 17 * * 1,2,3,4,5",
    // stop at 13:00 in Saturday
    "0 13 * * 6",
}

// Create a new schedule.
myFunctionLoop, err := hardloop.NewLoop(startSpecs, stopSpecs, MyFunction)
if err != nil {
    // wrong cron specs
    log.Fatal(err)
}

// run forever in goroutine (or until the function returns ErrLoopExited)
myFunctionLoop.RunWait(context.Background(), wg)

Set Logger

Implement Logger interface and set to the loop.

myFunctionLoop.SetLogger(myLog{})

Development

Test code

make test
# make coverage html-wsl