gocron

Dec 12, 2023

Changes in this version

type Scheduler

+ func (s *Scheduler) AfterJobRuns(eventListenerFunc func(jobName string)) *Scheduler

+ func (s *Scheduler) BeforeJobRuns(eventListenerFunc func(jobName string)) *Scheduler

+ func (s *Scheduler) WhenJobReturnsError(eventListenerFunc func(jobName string, err error)) *Scheduler

+ func (s *Scheduler) WhenJobReturnsNoError(eventListenerFunc func(jobName string)) *Scheduler

Nov 10, 2023

Changes in this version

type Job

+ func (j *Job) ScheduledInterval() int

+ func (j *Job) ScheduledUnit() string

Sep 29, 2023

Changes in this version

type Job

+ func (j *Job) GetName() string

Sep 18, 2023

Changes in this version

+ type Elector interface

+ IsLeader func(ctx context.Context) error

type Scheduler

+ func (s *Scheduler) WithDistributedElector(e Elector)

Aug 21, 2023

Changes in this version

type Scheduler

+ func (s *Scheduler) JobsMap() map[uuid.UUID]*Job

Aug 20, 2023

Changes in this version

+ var ErrInvalidMonthLastDayEntry = errors.New("gocron: only a single negative integer is permitted for MonthLastDay")

+ var ErrJobNotFound = errors.New("gocron: no job found")

type Scheduler

+ func (s *Scheduler) RemoveByID(job *Job) error

Jun 25, 2023

Changes in this version

type Scheduler

+ func (s *Scheduler) PauseJobExecution(shouldPause bool)

Jun 21, 2023

Changes in this version

+ type EventListener func(j *Job)

+ func AfterJobRuns(eventListenerFunc func(jobName string)) EventListener

+ func BeforeJobRuns(eventListenerFunc func(jobName string)) EventListener

+ func WhenJobReturnsError(eventListenerFunc func(jobName string, err error)) EventListener

+ func WhenJobReturnsNoError(eventListenerFunc func(jobName string)) EventListener

type Job

+ func (j *Job) RegisterEventListeners(eventListeners ...EventListener)

type Scheduler

+ func (s *Scheduler) RegisterEventListeners(eventListeners ...EventListener)

May 24, 2023

Changes in this version

type Job

+ func (j *Job) PreviousRun() time.Time

May 10, 2023

Changes in this version

type Job

+ func (j *Job) Name(name string)

type Scheduler

+ func (s *Scheduler) Name(name string) *Scheduler

May 5, 2023

Changes in this version

+ var ErrFailedToConnectToRedis = errors.New("gocron: failed to connect to redis")

+ var ErrFailedToObtainLock = errors.New("gocron: failed to obtain lock")

+ var ErrFailedToReleaseLock = errors.New("gocron: failed to release lock")

+ type Lock interface

+ Unlock func(ctx context.Context) error

type Locker

+ func NewRedisLocker(r *redis.Client) (Locker, error)

type Scheduler

+ func (s *Scheduler) WithDistributedLocker(l Locker)

Apr 23, 2023

Changes in this version

type Job

+ func (j *Job) Context() context.Context

Apr 13, 2023

Changes in this version

type Job

+ func (j *Job) FinishedRunCount() int

Apr 11, 2023

Changes in this version

type Scheduler

+ func (s *Scheduler) GetAllTags() []string

Aug 23, 2022

Changes in this version

type Scheduler

+ func (s *Scheduler) CustomTimer(customTimer func(d time.Duration, f func()) *time.Timer)

Aug 4, 2022

Changes in this version

type Scheduler

+ func (s *Scheduler) StopBlockingChan()

Jul 25, 2022

Changes in this version

type Scheduler

+ func (s *Scheduler) CustomTime(customTimeWrapper TimeWrapper)

+ type TimeWrapper interface

+ Now func(*time.Location) time.Time

+ Sleep func(time.Duration)

+ Unix func(int64, int64) time.Time

Jul 20, 2022

Changes in this version

+ var ErrInvalidFunctionParameters = errors.New("length of function parameters must match job function parameters")

Jun 14, 2022

Changes in this version

+ var ErrDoWithJobDetails = errors.New("DoWithJobDetails expects a function whose last parameter is a gocron.Job")

+ func SetPanicHandler(handler PanicHandlerFunc)

type Job

+ func (j *Job) SetEventListeners(onBeforeJobExecution interface{}, onAfterJobExecution interface{})

+ type PanicHandlerFunc func(jobName string, recoverData interface{})

type Scheduler

+ func (s *Scheduler) DoWithJobDetails(jobFun interface{}, params ...interface{}) (*Job, error)

+ func (s *Scheduler) EveryRandom(lower, upper int) *Scheduler

+ func (s *Scheduler) MonthFirstWeekday(weekday time.Weekday) *Scheduler

Feb 22, 2022

Changes in this version

type Job

+ func (j *Job) ScheduledAtTimes() []string

type Scheduler

+ func (s *Scheduler) RemoveByTagsAny(tags ...string) error

Feb 8, 2022

Changes in this version

type Scheduler

+ func (s *Scheduler) FindJobsByTag(tags ...string) ([]*Job, error)

+ func (s *Scheduler) Midday() *Scheduler

+ func (s *Scheduler) SingletonModeAll()

Dec 4, 2021

Changes in this version

type Scheduler

+ func (s *Scheduler) RemoveByTags(tags ...string) error

Nov 12, 2021

Changes in this version

type Job

+ func (j *Job) IsRunning() bool

type Scheduler

+ func (s *Scheduler) MonthLastDay() *Scheduler

Sep 13, 2021

Changes in this version

+ var ErrInvalidDayOfMonthEntry = errors.New("only days 1 through 28 are allowed for monthly schedules")

+ var ErrInvalidDaysOfMonthDuplicateValue = errors.New("duplicate days of month is not allowed in Month() and Months() methods")

May 25, 2021

Changes in this version

type Job

+ func (j *Job) Weekdays() []time.Weekday

Apr 16, 2021

Changes in this version

type Scheduler

+ func (s *Scheduler) WaitForSchedule() *Scheduler

+ func (s *Scheduler) WaitForScheduleAll()

Apr 13, 2021

Changes in this version

type Scheduler

+ func (s *Scheduler) CronWithSeconds(cronExpression string) *Scheduler

Apr 6, 2021

Changes in this version

+ var ErrCronParseFailure = errors.New("cron expression failed to be parsed")

type Scheduler

+ func (s *Scheduler) Cron(c string) *Scheduler

Apr 2, 2021

Changes in this version

+ var ErrUpdateCalledWithoutJob = errors.New("a call to Scheduler.Update() requires a call to Scheduler.Job() first")

type Scheduler

+ func (s *Scheduler) Job(j *Job) *Scheduler

+ func (s *Scheduler) RunByTag(tag string) error

+ func (s *Scheduler) RunByTagWithDelay(tag string, d time.Duration) error

+ func (s *Scheduler) Update() (*Job, error)

Mar 25, 2021

Changes in this version

+ var ErrWrongParams = errors.New("wrong list of params")

Mar 11, 2021

Changes in this version

+ var ErrAtTimeNotSupported = errors.New("the At() method is not supported for this time unit")

+ var ErrInvalidIntervalUnitsSelection = errors.New("an .Every() duration interval cannot be used with units (e.g. .Seconds())")

+ var ErrTagsUnique = func(tag string) error

+ var ErrWeekdayNotSupported = errors.New("weekday is not supported for time unit")

type Job

+ func (j *Job) Error() error

type Scheduler

+ func (s *Scheduler) Millisecond() *Scheduler

+ func (s *Scheduler) Milliseconds() *Scheduler

+ func (s *Scheduler) TagsUnique()

Feb 25, 2021

Changes in this version

+ const RescheduleMode

+ const WaitMode

type Job

+ func (j *Job) SingletonMode()

type Scheduler

+ func (s *Scheduler) SetMaxConcurrentJobs(n int, mode limitMode)

+ func (s *Scheduler) SingletonMode() *Scheduler

Feb 9, 2021

Changes in this version

+ var ErrInvalidInterval = errors.New(".Every() interval must be greater than 0")

+ var ErrInvalidIntervalType = errors.New(".Every() interval must be int, time.Duration, or string")

+ var ErrInvalidSelection = errors.New("an .Every() duration interval cannot be used with units (e.g. .Seconds())")

type Scheduler

+ func (s *Scheduler) LimitRunsTo(i int) *Scheduler

+ func (s *Scheduler) RemoveAfterLastRun() *Scheduler

+ func (s *Scheduler) RemoveByTag(tag string) error

+ func (s *Scheduler) Tag(t ...string) *Scheduler

+ func (s *Scheduler) TaskPresent(j interface{}) bool

Dec 30, 2020

Changes in this version

type Job

+ func (j *Job) RemoveAfterLastRun() *Job

type Scheduler

+ func (s *Scheduler) IsRunning() bool

+ func (s *Scheduler) Location() *time.Location

Dec 11, 2020

Changes in this version

type Job

+ func (j *Job) LastRun() time.Time

+ func (j *Job) NextRun() time.Time

+ func (j *Job) RunCount() int

Oct 5, 2020

Changes in this version

type Job

+ func (j *Job) LimitRunsTo(n int)

Jul 20, 2020

Changes in this version

+ var ErrUnsupportedTimeFormat = errors.New("the given time format is not supported")

type Scheduler

+ func (s *Scheduler) Month(dayOfTheMonth int) *Scheduler

+ func (s *Scheduler) Months(dayOfTheMonth int) *Scheduler

May 25, 2020

Changes in this version

+ var ErrJobNotFoundWithTag = errors.New("no jobs found with given tag")

type Job

+ func (j *Job) ScheduledAtTime() string

+ func (j *Job) ScheduledTime() time.Time

+ func (j *Job) Weekday() (time.Weekday, error)

type Scheduler

+ func (s *Scheduler) ChangeLocation(newLocation *time.Location)

+ func (s *Scheduler) RemoveByReference(j *Job)

+ func (s *Scheduler) RemoveJobByTag(tag string) error

+ func (s *Scheduler) SetTag(t []string) *Scheduler

+ func (s *Scheduler) StartAsync() chan struct{}

+ func (s *Scheduler) StartBlocking()

+ func (s *Scheduler) Stop()

Apr 10, 2020

Changes in this version

+ var ErrNotScheduledWeekday = errors.New("job not scheduled weekly on a weekday")

type Job

+ func (j *Job) GetScheduledTime() string

Mar 28, 2020

Changes in this version

+ var ErrNotAFunction = errors.New("only functions can be schedule into the job queue")

+ var ErrParameterCannotBeNil = errors.New("nil paramaters cannot be used with reflection")

+ var ErrParamsNotAdapted = errors.New("the number of params is not adapted")

+ var ErrPeriodNotSpecified = errors.New("unspecified job period")

+ var ErrTimeFormat = errors.New("time format error")

+ func SetLocker(l Locker)

+ type Job struct

+ func NewJob(interval uint64) *Job

+ func (j *Job) Err() error

+ func (j *Job) GetAt() string

+ func (j *Job) GetWeekday() time.Weekday

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

+ func (j *Job) Tag(t string, others ...string)

+ func (j *Job) Tags() []string

+ func (j *Job) Untag(t string)

+ type Locker interface

+ Lock func(key string) (bool, error)

+ Unlock func(key string) error

+ type Scheduler struct

+ func NewScheduler(loc *time.Location) *Scheduler

+ func (s *Scheduler) At(t string) *Scheduler

+ func (s *Scheduler) Clear()

+ func (s *Scheduler) Day() *Scheduler

+ func (s *Scheduler) Days() *Scheduler

+ func (s *Scheduler) Do(jobFun interface{}, params ...interface{}) (*Job, error)

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

+ func (s *Scheduler) Friday() *Scheduler

+ func (s *Scheduler) Hour() *Scheduler

+ func (s *Scheduler) Hours() *Scheduler

+ func (s *Scheduler) Jobs() []*Job

+ func (s *Scheduler) Len() int

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

+ func (s *Scheduler) Lock() *Scheduler

+ func (s *Scheduler) Minute() *Scheduler

+ func (s *Scheduler) Minutes() *Scheduler

+ func (s *Scheduler) Monday() *Scheduler

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

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

+ func (s *Scheduler) RemoveByRef(j *Job)

+ func (s *Scheduler) RunAll()

+ func (s *Scheduler) RunAllWithDelay(d int)

+ func (s *Scheduler) RunPending()

+ func (s *Scheduler) Saturday() *Scheduler

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

+ func (s *Scheduler) Second() *Scheduler

+ func (s *Scheduler) Seconds() *Scheduler

+ func (s *Scheduler) SetLocation(newLocation *time.Location)

+ func (s *Scheduler) Start() chan struct{}

+ func (s *Scheduler) StartAt(t time.Time) *Scheduler

+ func (s *Scheduler) StartImmediately() *Scheduler

+ func (s *Scheduler) Sunday() *Scheduler

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

+ func (s *Scheduler) Thursday() *Scheduler

+ func (s *Scheduler) Tuesday() *Scheduler

+ func (s *Scheduler) Wednesday() *Scheduler

+ func (s *Scheduler) Week() *Scheduler

+ func (s *Scheduler) Weekday(startDay time.Weekday) *Scheduler

+ func (s *Scheduler) Weeks() *Scheduler