concurrency

Documentation

Index

• type WorkerPool
  • func NewWorkerPool[MsgType any](workers int, queueRatio int) *WorkerPool[MsgType]
  • func (w *WorkerPool[MsgType]) Queue(msg MsgType)
  • func (w *WorkerPool[MsgType]) SetProcessor(fn func(context.Context, MsgType) error)
  • func (w *WorkerPool[MsgType]) Start() error
  • func (w *WorkerPool[MsgType]) Stop() error

Types

type WorkerPool

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

WorkerPool represents a proccessor for MsgType objects, using a worker pool to allocate resources.

func NewWorkerPool

func NewWorkerPool[MsgType any](workers int, queueRatio int) *WorkerPool[MsgType]

New returns a new WorkerPool[MsgType] with given number of workers and queue ratio, where the queue ratio is multiplied by no. workers to get queue size. If args < 1 then suitable defaults are determined from the runtime's GOMAXPROCS variable.

func (*WorkerPool[MsgType]) Queue

func (w *WorkerPool[MsgType]) Queue(msg MsgType)

Queue will queue provided message to be processed with there's a free worker.

func (*WorkerPool[MsgType]) SetProcessor

func (w *WorkerPool[MsgType]) SetProcessor(fn func(context.Context, MsgType) error)

SetProcessor will set the Worker's processor function, which is called for each queued message.

func (*WorkerPool[MsgType]) Start

func (w *WorkerPool[MsgType]) Start() error

Start will attempt to start the underlying worker pool, or return error.

func (*WorkerPool[MsgType]) Stop

func (w *WorkerPool[MsgType]) Stop() error

Stop will attempt to stop the underlying worker pool, or return error.