sync

Documentation

Index

• type WorkPool
  • func NewWorkPool(ctx context.Context, workers int, opts ...WorkPoolOption) *WorkPool
  • func (wq *WorkPool) Add(id string, fn func())
  • func (wq *WorkPool) Run()
  • func (wq *WorkPool) Status(id string) bool
• type WorkPoolOption
  • func WithWorkPoolLogger(logger func(string, ...interface{})) WorkPoolOption

Types

type WorkPool

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

WorkPool is a pool of work to be done.

func NewWorkPool

func NewWorkPool(ctx context.Context, workers int, opts ...WorkPoolOption) *WorkPool

NewWorkPool creates a new work pool. The workers argument specifies the number of concurrent workers to run the work. The queue will chunk the work into batches of workers size.

func (*WorkPool) Add

func (wq *WorkPool) Add(id string, fn func())

Add adds a new job to the pool. If the job already exists, it is a no-op.

func (*WorkPool) Run

func (wq *WorkPool) Run()

Run starts the workers and waits for them to finish.

func (*WorkPool) Status

func (wq *WorkPool) Status(id string) bool

Status checks if a job is in the queue.

type WorkPoolOption

type WorkPoolOption func(*WorkPool)

WorkPoolOption is a function that configures a WorkPool.

func WithWorkPoolLogger

func WithWorkPoolLogger(logger func(string, ...interface{})) WorkPoolOption

WithWorkPoolLogger sets the logger to use.