worker

Documentation

Index

• type Ticker
  • func NewTicker(logger log.Logger, opts ...TickerOption) *Ticker
  • func (wt *Ticker) GetID() string
  • func (wt *Ticker) Run(ctx context.Context, cancelChan chan struct{}, ...)
• type TickerOption
  • func WithTickerDuration(pollDuration time.Duration) TickerOption

Types

type Ticker

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

Ticker is a worker that runs periodically

func NewTicker

func NewTicker(logger log.Logger, opts ...TickerOption) *Ticker

NewTicker creates a new worker that does an action periodically

func (*Ticker) GetID

func (wt *Ticker) GetID() string

GetID fetch identifier of a worker

func (*Ticker) Run

func (wt *Ticker) Run(ctx context.Context, cancelChan chan struct{}, handlerFn func(ctx context.Context, runningAt time.Time) error)

Run starts worker that handle a task periodically

type TickerOption

type TickerOption func(*Ticker)

TickerOption is an option to customize worker ticker creation

func WithTickerDuration

func WithTickerDuration(pollDuration time.Duration) TickerOption

WithTickerDuration sets created handler with the specified poll duration