worker

Documentation

Index

• func StartScheduled(cfg Config) error
• type Config
• type CronJob
• type Job
• type JobHandle
• type Pool
  • func NewPool(logger zerolog.Logger, options ...PoolOption) *Pool
  • func (p *Pool) Shutdown()
  • func (p *Pool) Submit(ctx context.Context, j Job) JobHandle
• type PoolOption
  • func PoolStopTimeout(t time.Duration) PoolOption
• type Scheduler
  • func NewScheduler(logger zerolog.Logger) (*Scheduler, error)
  • func (s *Scheduler) Schedule(ctx context.Context, cronexpr string, j Job) (JobHandle, error)
  • func (s *Scheduler) ScheduleEvery(ctx context.Context, t time.Duration, j Job) (JobHandle, error)
  • func (s *Scheduler) Shutdown()
  • func (s *Scheduler) Start()

Functions

func StartScheduled

func StartScheduled(cfg Config) error

Types

type Config

type Config struct {
	Logger  zerolog.Logger
	Crontab []CronJob
}

type CronJob

type CronJob struct {
	Cron string
	Job  Job
}

type Job

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

type JobHandle

type JobHandle interface {
	Wait() <-chan error
}

type Pool

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

func NewPool

func NewPool(logger zerolog.Logger, options ...PoolOption) *Pool

func (*Pool) Shutdown

func (p *Pool) Shutdown()

func (*Pool) Submit

func (p *Pool) Submit(ctx context.Context, j Job) JobHandle

type PoolOption

type PoolOption func(*Pool)

func PoolStopTimeout

func PoolStopTimeout(t time.Duration) PoolOption

type Scheduler

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

func NewScheduler

func NewScheduler(logger zerolog.Logger) (*Scheduler, error)

func (*Scheduler) Schedule

func (s *Scheduler) Schedule(ctx context.Context, cronexpr string, j Job) (JobHandle, error)

func (*Scheduler) ScheduleEvery

func (s *Scheduler) ScheduleEvery(ctx context.Context, t time.Duration, j Job) (JobHandle, error)

func (*Scheduler) Shutdown

func (s *Scheduler) Shutdown()

func (*Scheduler) Start

func (s *Scheduler) Start()