pool

Documentation

Index

• type Pool
  • func NewPool(tasks []*Task, concurrency int) *Pool
  • func (p *Pool) GetErrors() error
  • func (p *Pool) HasErrors() bool
  • func (p *Pool) Run()
• type Task
  • func NewTask(f func() (TaskResult, error)) *Task
  • func (t *Task) Run(wg *sync.WaitGroup)
• type TaskResult

Types

type Pool

type Pool struct {
	Tasks []*Task
	// contains filtered or unexported fields
}

Pool is a worker group that runs a number of tasks at a configured concurrency.

func NewPool

func NewPool(tasks []*Task, concurrency int) *Pool

NewPool initializes a new pool with the given tasks and at the given concurrency.

func (*Pool) GetErrors

func (p *Pool) GetErrors() error

GetErrors returns all errors from tasks run. Its result is only meaningful after Run has been called.

func (*Pool) HasErrors

func (p *Pool) HasErrors() bool

HasErrors indicates whether there were any errors from tasks run. Its result is only meaningful after Run has been called.

func (*Pool) Run

func (p *Pool) Run()

Run runs all work within the pool and blocks until it's finished.

type Task

type Task struct {
	// Err holds an error that occurred during a task. Its result is only
	// meaningful after Run has been called for the pool that holds it.
	Err    error
	Result TaskResult
	// contains filtered or unexported fields
}

Task encapsulates a work item that should go in a work pool.

func NewTask

func NewTask(f func() (TaskResult, error)) *Task

NewTask initializes a new task based on a given work function.

func (*Task) Run

func (t *Task) Run(wg *sync.WaitGroup)

Run runs a Task and does appropriate accounting via a given sync.WorkGroup.

type TaskResult

type TaskResult interface{}