worker

Documentation

Overview

Package worker implements a worker pool.

Index

• type Func
• type Job
• type Pool
  • func New(ctx context.Context, n int, f Func, jobChan <-chan Job, resultChan chan<- Job) *Pool
  • func (p *Pool) Wait()

Types

type Func

type Func func(ctx context.Context, job Job) (result interface{}, err error)

Func does the actual work within a Pool.

type Job

type Job struct {
	Data   interface{}
	Result interface{}
	Error  error
}

Job is one unit of work. It is given to a Func, and the returned result and error are stored in Result and Error.

type Pool

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

Pool implements a worker pool.

func New

func New(ctx context.Context, n int, f Func, jobChan <-chan Job, resultChan chan<- Job) *Pool

New returns a new worker pool with n goroutines, each running the function f. The workers are started immediately.

func (*Pool) Wait

func (p *Pool) Wait()

Wait waits for all worker goroutines to terminate, afterwards the output channel is closed.