parallelwork

Documentation

Overview

Package parallelwork implements pallel work queue with fixed number of workers that concurrently process and add work items to the queue.

Index

• type CallbackFunc
• type Queue
  • func NewQueue() *Queue
  • func (v *Queue) EnqueueBack(callback CallbackFunc)
  • func (v *Queue) EnqueueFront(callback CallbackFunc)
  • func (v *Queue) Process(workers int) error

Types

type CallbackFunc

type CallbackFunc func() error

CallbackFunc is a callback function

type Queue

type Queue struct {
	ProgressCallback func(enqueued, active, completed int64)
	// contains filtered or unexported fields
}

Queue represents a work queue with multiple parallel workers.

func NewQueue

func NewQueue() *Queue

NewQueue returns new parallel work queue.

func (*Queue) EnqueueBack

func (v *Queue) EnqueueBack(callback CallbackFunc)

EnqueueBack adds the work to the back of the queue.

func (*Queue) EnqueueFront

func (v *Queue) EnqueueFront(callback CallbackFunc)

EnqueueFront adds the work to the front of the queue.

func (*Queue) Process

func (v *Queue) Process(workers int) error

Process starts N workers, which will be processing elements in the queue until the queue is empty and all workers are idle or until any of the workers returns an error.