cron

Documentation

Index

• func SetUp(job *Cron)
• type Config
  • func (config *Config) Events() (res map[string]string)
• type Cron
  • func NewCron(config *Config, logger log.Logger) (c *Cron)
  • func (c *Cron) AddEvent(name string, event Event)
  • func (c *Cron) Start()
  • func (c *Cron) Stop()
• type Event

Functions

func SetUp

func SetUp(job *Cron)

SetUp set instance

Types

type Config

type Config struct {
	Enable bool                `mapstructure:"enable"`
	Specs  map[string][]string `mapstructure:"specs"` // one spec to multi events
}

Config ..

func (*Config) Events

func (config *Config) Events() (res map[string]string)

Events 返回定时任务配置

type Cron

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

Cron type

var CronJob *Cron

CronJob cron job instance

func NewCron

func NewCron(config *Config, logger log.Logger) (c *Cron)

NewCron server init

func (*Cron) AddEvent

func (c *Cron) AddEvent(name string, event Event)

AddEvent name is the unique key and event must define in cron config

func (*Cron) Start

func (c *Cron) Start()

Start cron

func (*Cron) Stop

func (c *Cron) Stop()

Stop cron

type Event

type Event func()

Event func