ecron

Documentation

Index

• Constants
• type Component
  • func (c *Component) Init() error
  • func (c *Component) Name() string
  • func (c *Component) PackageName() string
  • func (c *Component) Start() error
  • func (c *Component) Stop() error
• type Config
  • func DefaultConfig() *Config
• type Container
  • func DefaultContainer() *Container
  • func Load(key string) *Container
  • func (c *Container) Build(options ...Option) *Component
• type Ecron
• type Entry
• type EntryID
• type FuncJob
  • func (f FuncJob) Name() string
  • func (f FuncJob) Run(ctx context.Context) error
• type Job
• type JobWrapper
• type Lock
• type NamedJob
• type Option
  • func WithJob(job FuncJob) Option
  • func WithLocation(loc *time.Location) Option
  • func WithLock(lock Lock) Option
  • func WithParser(p cron.Parser) Option
  • func WithSeconds() Option
  • func WithWrappers(wrappers ...JobWrapper) Option
• type Parser
• type Schedule

Constants

const PackageName = "task.ecron"

PackageName 包名

Types

type Component

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

Component ...

func (*Component) Init

func (c *Component) Init() error

Init Init

func (*Component) Name

func (c *Component) Name() string

Name 名称

func (*Component) PackageName

func (c *Component) PackageName() string

PackageName 包名

func (*Component) Start

func (c *Component) Start() error

Start ...

func (*Component) Stop

func (c *Component) Stop() error

Stop ...

type Config

type Config struct {
	// Required. 触发时间
	//	默认最小单位为分钟.比如:
	//		"* * * * *" 代表每分钟执行
	//	如果 EnableSeconds = true. 那么最小单位为秒. 示例:
	//		"*/3 * * * * *" 代表每三秒钟执行一次
	Spec string

	WaitLockTime   time.Duration // 抢锁等待时间，默认 4s
	LockTTL        time.Duration // 租期，默认 16s
	RefreshGap     time.Duration // 锁刷新间隔时间， 默认 4s
	WaitUnlockTime time.Duration // 解锁等待时间，默认 1s

	DelayExecType         string // skip，queue，concurrent，如果上一个任务执行较慢，到达了新任务执行时间，那么新任务选择跳过，排队，并发执行的策略，新任务默认选择skip策略
	Enable                bool   // 是否启用定时任务，默认 true，代表启用. 如果为 false 则该定时任务不会运行
	EnableDistributedTask bool   // 是否分布式任务，默认否，如果存在分布式任务，会只执行该定时人物
	EnableImmediatelyRun  bool   // 是否立刻执行，默认否
	EnableSeconds         bool   // 是否使用秒作解析器，默认否
	// contains filtered or unexported fields
}

Config ...

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig ...

type Container

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

Container defines a component instance.

func DefaultContainer

func DefaultContainer() *Container

DefaultContainer returns an default container.

func Load

func Load(key string) *Container

Load parses container configuration from configuration provider, such as a toml file, then use the configuration to construct a component container.

func (*Container) Build

func (c *Container) Build(options ...Option) *Component

Build constructs a specific component from container.

type Ecron

type Ecron interface {
	standard.Component
}

Ecron ...

type Entry

type Entry = cron.Entry

Entry ...

type EntryID

type EntryID = cron.EntryID

EntryID ...

type FuncJob

type FuncJob func(ctx context.Context) error

FuncJob ...

func (FuncJob) Name

func (f FuncJob) Name() string

Name ...

func (FuncJob) Run

func (f FuncJob) Run(ctx context.Context) error

Run ...

type Job

type Job = cron.Job

Job ...

type JobWrapper

type JobWrapper = cron.JobWrapper

JobWrapper ...

type Lock

type Lock interface {
	Lock(ctx context.Context, ttl time.Duration) error
	Unlock(ctx context.Context) error
	Refresh(ctx context.Context, ttl time.Duration) error
}

Lock ... implementations:

Redis: [ecronlock](github.com/gotomicro/eredis@v0.2.0+)

type NamedJob

type NamedJob interface {
	Run(ctx context.Context) error
	Name() string
}

NamedJob ..

type Option

type Option func(c *Container)

Option ...

func WithJob

func WithJob(job FuncJob) Option

WithJob 指定Job

func WithLocation

func WithLocation(loc *time.Location) Option

WithLocation 设置时区

func WithLock

func WithLock(lock Lock) Option

WithLock 设置分布式锁. 当 Config.EnableDistributedTask = true 时, 本 Option 必须设置

func WithParser

func WithParser(p cron.Parser) Option

WithParser 设置时间 parser

func WithSeconds

func WithSeconds() Option

WithSeconds 开启秒单位

func WithWrappers

func WithWrappers(wrappers ...JobWrapper) Option

WithWrappers 设置 JobWrapper

type Parser

type Parser = cron.Parser

Parser ...

type Schedule

type Schedule = cron.Schedule

Schedule ...