worker

Documentation

Overview

Package worker performs heavy-lifting tasks in the background.

Index

• func Add(ctx context.Context, name string, job Job, options ...Option) <-chan error
• func AddAndWait(ctx context.Context, name string, job Job, options ...Option) error
• type Job
• type Option
  • func WithMaxLogFrequency(d time.Duration) Option

Functions

func Add

func Add(ctx context.Context, name string, job Job, options ...Option) <-chan error

Add adds a job to the end of the queue (FIFO).

The returned channel can be queried to get the job result.

func AddAndWait

func AddAndWait(ctx context.Context, name string, job Job, options ...Option) error

AddAndWait adds the job to the queue and blocks until the job is finished.

It returns the error from the job or the context's error, whatever happens first.

Types

type Job

type Job func(ctx context.Context, progressChan chan<- float64) error

Job performs a task.

type Option

type Option func(o *options)

func WithMaxLogFrequency

func WithMaxLogFrequency(d time.Duration) Option