cron

Documentation

Index

• type Clock
  • func (c *Clock) Now() time.Time
• type Cron
  • func New() *Cron
  • func (c *Cron) At(hour string) *Cron
  • func (c *Cron) Clock(clock *Clock) *Cron
  • func (c *Cron) Days() *Cron
  • func (c *Cron) Each(interval time.Duration) *Cron
  • func (c *Cron) Friday() *Cron
  • func (c *Cron) In(tz string) *Cron
  • func (c *Cron) MaxRetry(maxRetry uint) *Cron
  • func (c *Cron) Monday() *Cron
  • func (c *Cron) Now() *Cron
  • func (c *Cron) Retry(retryInterval time.Duration) *Cron
  • func (c *Cron) Saturday() *Cron
  • func (c *Cron) Start(action func(time.Time) error, onError func(error))
  • func (c *Cron) Stop()
  • func (c *Cron) String() string
  • func (c *Cron) Sunday() *Cron
  • func (c *Cron) Thursday() *Cron
  • func (c *Cron) Tuesday() *Cron
  • func (c *Cron) Wednesday() *Cron
  • func (c *Cron) Weekdays() *Cron

Types

type Clock

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

Clock give time

func (*Clock) Now

func (c *Clock) Now() time.Time

Now return current time

type Cron

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

Cron definition

func New

func New() *Cron

New create new cron

func (*Cron) At

func (c *Cron) At(hour string) *Cron

At set hour of run in format HH:MM

func (*Cron) Clock

func (c *Cron) Clock(clock *Clock) *Cron

Clock set clock that give current time, mostly for testing purpose

func (*Cron) Days

func (c *Cron) Days() *Cron

Days set recurence to every day

func (*Cron) Each

func (c *Cron) Each(interval time.Duration) *Cron

Each set interval of each run

func (*Cron) Friday

func (c *Cron) Friday() *Cron

Friday set recurence to every Friday

func (*Cron) In

func (c *Cron) In(tz string) *Cron

In set timezone

func (*Cron) MaxRetry

func (c *Cron) MaxRetry(maxRetry uint) *Cron

MaxRetry set maximum retry count

func (*Cron) Monday

func (c *Cron) Monday() *Cron

Monday set recurence to every Monday

func (*Cron) Now

func (c *Cron) Now() *Cron

Now run cron now

func (*Cron) Retry

func (c *Cron) Retry(retryInterval time.Duration) *Cron

Retry set interval retry if action failed

func (*Cron) Saturday

func (c *Cron) Saturday() *Cron

Saturday set recurence to every Saturday

func (*Cron) Start

func (c *Cron) Start(action func(time.Time) error, onError func(error))

Start cron

func (*Cron) Stop

func (c *Cron) Stop()

Stop cron

func (*Cron) String

func (c *Cron) String() string

func (*Cron) Sunday

func (c *Cron) Sunday() *Cron

Sunday set recurence to every Sunday

func (*Cron) Thursday

func (c *Cron) Thursday() *Cron

Thursday set recurence to every Thursday

func (*Cron) Tuesday

func (c *Cron) Tuesday() *Cron

Tuesday set recurence to every Tuesday

func (*Cron) Wednesday

func (c *Cron) Wednesday() *Cron

Wednesday set recurence to every Wednesday

func (*Cron) Weekdays

func (c *Cron) Weekdays() *Cron

Weekdays set recurence to every day except sunday and saturday