cron

Documentation

Index

• type Cron
  • func New() *Cron
  • func (c *Cron) At(hour string) *Cron
  • func (c *Cron) Days() *Cron
  • func (c *Cron) Each(interval time.Duration) *Cron
  • func (c *Cron) Exclusive(redisApp redis.App, name string, timeout 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) OnError(onError func(error)) *Cron
  • func (c *Cron) OnSignal(signal os.Signal) *Cron
  • func (c *Cron) Retry(retryInterval time.Duration) *Cron
  • func (c *Cron) Saturday() *Cron
  • func (c *Cron) Shutdown()
  • func (c *Cron) Start(action func(context.Context) error, done <-chan struct{})
  • 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 Cron

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

Cron definition

func New

func New() *Cron

New creates new cron

func (*Cron) At

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

At sets hour of run in format HH:MM

func (*Cron) Days

func (c *Cron) Days() *Cron

Days sets recurence to every day

func (*Cron) Each

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

Each sets interval of each run

func (*Cron) Exclusive

func (c *Cron) Exclusive(redisApp redis.App, name string, timeout time.Duration) *Cron

Exclusive runs cron in an exclusive manner with a distributed lock on Redis

func (*Cron) Friday

func (c *Cron) Friday() *Cron

Friday sets recurence to every Friday

func (*Cron) In

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

In sets timezone

func (*Cron) MaxRetry

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

MaxRetry sets maximum retry count

func (*Cron) Monday

func (c *Cron) Monday() *Cron

Monday sets recurence to every Monday

func (*Cron) Now

func (c *Cron) Now() *Cron

Now run cron now

func (*Cron) OnError

func (c *Cron) OnError(onError func(error)) *Cron

OnError defines error handling function

func (*Cron) OnSignal

func (c *Cron) OnSignal(signal os.Signal) *Cron

OnSignal sets signal listened for trigerring cron

func (*Cron) Retry

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

Retry sets interval retry if action failed

func (*Cron) Saturday

func (c *Cron) Saturday() *Cron

Saturday sets recurence to every Saturday

func (*Cron) Shutdown

func (c *Cron) Shutdown()

Shutdown cron, do not attempt Start() after

func (*Cron) Start

func (c *Cron) Start(action func(context.Context) error, done <-chan struct{})

Start cron

func (*Cron) String

func (c *Cron) String() string

func (*Cron) Sunday

func (c *Cron) Sunday() *Cron

Sunday sets recurence to every Sunday

func (*Cron) Thursday

func (c *Cron) Thursday() *Cron

Thursday sets recurence to every Thursday

func (*Cron) Tuesday

func (c *Cron) Tuesday() *Cron

Tuesday sets recurence to every Tuesday

func (*Cron) Wednesday

func (c *Cron) Wednesday() *Cron

Wednesday sets recurence to every Wednesday

func (*Cron) Weekdays

func (c *Cron) Weekdays() *Cron

Weekdays sets recurence to every day except sunday and saturday