workerpoolmdl

Documentation

Index

• type Pool
  • func NewPool(tasks []*Task, concurrency int) *Pool
  • func (p *Pool) Run()
• type PoolWithContext
  • func NewPoolWithContext(tasks []*TaskWithContext, concurrency int) *PoolWithContext
  • func (p *PoolWithContext) Cancel()
  • func (p *PoolWithContext) Run()
• type Task
  • func NewTask(d interface{}, f func(data interface{}) error) *Task
  • func (t *Task) Run(wg *sync.WaitGroup)
• type TaskWithContext
  • func NewTaskWithContext(d interface{}, f func(data interface{}) error) *TaskWithContext
  • func (t *TaskWithContext) Run(p *PoolWithContext)

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) Run

func (p *Pool) Run()

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

type PoolWithContext

type PoolWithContext struct {
	Tasks []*TaskWithContext

	CancelHandler  *cancelHandler
	IsPoolCanceled bool
	// contains filtered or unexported fields
}

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

func NewPoolWithContext

func NewPoolWithContext(tasks []*TaskWithContext, concurrency int) *PoolWithContext

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

func (*PoolWithContext) Cancel

func (p *PoolWithContext) Cancel()

Cancel all tasks

func (*PoolWithContext) Run

func (p *PoolWithContext) Run()

Run runs all work within the pool

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

	Data interface{}
	// contains filtered or unexported fields
}

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

func NewTask

func NewTask(d interface{}, f func(data interface{}) 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 TaskWithContext

type TaskWithContext 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

	Data interface{}
	// contains filtered or unexported fields
}

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

func NewTaskWithContext

func NewTaskWithContext(d interface{}, f func(data interface{}) error) *TaskWithContext

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

func (*TaskWithContext) Run

func (t *TaskWithContext) Run(p *PoolWithContext)

Run runs a Task and does appropriate accounting via a