jobs

Documentation

Index

• func AddJobToScheduler(j Job)
• func AddJobsToScheduler(jobs []Job)
• func AfterOrEqualTo(t1, t2 time.Time) bool
• func Announce(name, inAction string)
• func BeforeOrEqualTo(t1, t2 time.Time) bool
• func CodedName(job Job) string
• func GetHumanReadableCronFreq(freq string) string
• func Initialise(cfg *commonConfig.Settings) error
• func NextRun(name, schedule string) string
• func PostRun(job Job)
• func PreRun(job Job)
• func StartOfDay(t time.Time) time.Time
• func StartScheduler()
• type Job

Functions

func AddJobToScheduler

func AddJobToScheduler(j Job)

func AddJobsToScheduler

func AddJobsToScheduler(jobs []Job)

func AfterOrEqualTo

func AfterOrEqualTo(t1, t2 time.Time) bool

func Announce

func Announce(name, inAction string)

Announce - Announce the start of a job to the log Deprecated: Use PreRun instead

func BeforeOrEqualTo

func BeforeOrEqualTo(t1, t2 time.Time) bool

func CodedName

func CodedName(job Job) string

func GetHumanReadableCronFreq

func GetHumanReadableCronFreq(freq string) string

func Initialise

func Initialise(cfg *commonConfig.Settings) error

func NextRun

func NextRun(name, schedule string) string

func PostRun

func PostRun(job Job)

func PreRun

func PreRun(job Job)

func StartOfDay

func StartOfDay(t time.Time) time.Time

func StartScheduler

func StartScheduler()

Types

type Job

type Job interface {
	Run() error
	Service() func()
	Schedule() string
	Name() string
	AddDatabaseAccessFunctions(f func() ([]*database.DB, error))
	Description() string
}