pool

Documentation

Index

• func NewWorker[T any](id int, readyPool chan chan Task[T], done *sync.WaitGroup) *worker[T]
• type Parallel
  • func NewParallel[T any](maxWorkers int, capacity int) *Parallel[T]
  • func (q *Parallel[T]) Enqueue(item T) bool
  • func (q *Parallel[T]) EnqueueWithTimeout(item T, timeout time.Duration) bool
  • func (q *Parallel[T]) Start(processor func(T)) error
  • func (q *Parallel[T]) Submit(item T)
  • func (q *Parallel[T]) WaitAll()
• type Task
• type WorkerPool
  • func NewWorkerPool[T any](maxWorkers int, capacity int) *WorkerPool[T]
  • func (q *WorkerPool[T]) Enqueue(task Task[T]) bool
  • func (q *WorkerPool[T]) EnqueueWithTimeout(task Task[T], timeout time.Duration) bool
  • func (q *WorkerPool[T]) Start(callback func(T)) error
  • func (q *WorkerPool[T]) Stop()
  • func (q *WorkerPool[T]) Submit(task Task[T])

Functions

func NewWorker

func NewWorker[T any](id int, readyPool chan chan Task[T], done *sync.WaitGroup) *worker[T]

Types

type Parallel

type Parallel[T any] struct {
	// contains filtered or unexported fields
}

Parallel is a concurrency utility enable user to use the same processor (function) to process multiple objects in parallel using multiple workers. This utility is similar to WorkerPool but the main difference is that it is using the same function to reduce number of allocations

func NewParallel

func NewParallel[T any](maxWorkers int, capacity int) *Parallel[T]

func (*Parallel[T]) Enqueue

func (q *Parallel[T]) Enqueue(item T) bool

Enqueue submits a task to the buffered job queue without blocking, returns false if queue is full

func (*Parallel[T]) EnqueueWithTimeout

func (q *Parallel[T]) EnqueueWithTimeout(item T, timeout time.Duration) bool

EnqueueWithTimeout submits a task to the buffered job queue without blocking, returns false if queue is full within the duration

func (*Parallel[T]) Start

func (q *Parallel[T]) Start(processor func(T)) error

Start pool with processor function to be called for any object in the queue

func (*Parallel[T]) Submit

func (q *Parallel[T]) Submit(item T)

Submit a task to the job queue, blocked if no workers are available

func (*Parallel[T]) WaitAll

func (q *Parallel[T]) WaitAll()

WaitAll blocks until completion of all tasks in the queue

type Task

type Task[T any] interface {
	Run() T
}

Task is interface for any job executed by the worker pool

type WorkerPool

type WorkerPool[T any] struct {
	// contains filtered or unexported fields
}

func NewWorkerPool

func NewWorkerPool[T any](maxWorkers int, capacity int) *WorkerPool[T]

func (*WorkerPool[T]) Enqueue

func (q *WorkerPool[T]) Enqueue(task Task[T]) bool

Enqueue submits a task to the buffered job queue without blocking, returns false if queue is full

func (*WorkerPool[T]) EnqueueWithTimeout

func (q *WorkerPool[T]) EnqueueWithTimeout(task Task[T], timeout time.Duration) bool

EnqueueWithTimeout submits a task to the buffered job queue without blocking, returns false if queue is full within the duration

func (*WorkerPool[T]) Start

func (q *WorkerPool[T]) Start(callback func(T)) error

Start pool with optional callback to be invoked on task completion

func (*WorkerPool[T]) Stop

func (q *WorkerPool[T]) Stop()

func (*WorkerPool[T]) Submit

func (q *WorkerPool[T]) Submit(task Task[T])

Submit a task to the job queue, blocked if no workers are available