worker

Documentation

Index

• type Builder
  • func NewWorkerBuilder(name string, workerFn func(context.Context) error) Builder
• type Options
  • func DefaultOptions(interval time.Duration) *Options
• type Worker

Types

type Builder

type Builder interface {
	WithOptions(options *Options) Builder
	WithStop(func() error) Builder
	Build() Worker
}

func NewWorkerBuilder

func NewWorkerBuilder(name string, workerFn func(context.Context) error) Builder

type Options

type Options struct {
	Interval        time.Duration
	RunImmediately  bool
	RunConsequently bool
}

func DefaultOptions

func DefaultOptions(interval time.Duration) *Options

type Worker

type Worker interface {
	Name() string
	Start(ctx context.Context, wg *sync.WaitGroup)
}

Worker interface can be constructed using worker.NewBuilder("worker_name", workerFn).Build() or allows custom implementation (e.g. one-off jobs)