workerpool

package

v1.27.1 Latest Latest Go to latest Published: Oct 27, 2026 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/nt0xa/sonar

Links

Open Source Insights

Documentation ¶

Overview ¶

Package workerpool provides a generic buffered worker pool: items submitted via Submit are fanned out across a fixed number of worker goroutines, each running the handler.

Index ¶

Variables
type Option
type Pool
- func New[T any](handler func(T), opts ...Option) *Pool[T]

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrStopped = errors.New("workerpool: stopped")

ErrStopped is returned by Submit when the pool is stopped.

Functions ¶

This section is empty.

Types ¶

type Option ¶

type Option func(*options)

func WithCapacity ¶

func WithCapacity(n int) Option

WithCapacity sets the number of items buffered before Submit blocks.

func WithRateLimit ¶

func WithRateLimit(limit rate.Limit, burst int) Option

WithRateLimit caps how fast items are handled across all workers.

func WithWorkers ¶

func WithWorkers(n int) Option

WithWorkers sets the number of goroutines running the handler.

type Pool ¶

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

func New ¶

func New[T any](
	handler func(T),
	opts ...Option,
) *Pool[T]

New creates a Pool, panics on invalid arguments.

func (*Pool[T]) Stop ¶

func (p *Pool[T]) Stop(ctx context.Context) error

Stop rejects new submissions, handles buffered items and waits for the workers to finish. If ctx is done first, its error is returned and workers may still be running; calling Stop again waits again.

func (*Pool[T]) Submit ¶

func (p *Pool[T]) Submit(value T) error

Submit enqueues value, blocking while the buffer is full. It returns ErrStopped if the pool is stopped.

func (*Pool[T]) TrySubmit ¶

func (p *Pool[T]) TrySubmit(value T) bool

TrySubmit is like Submit but doesn't block: it returns false if the buffer is full or the pool is stopped.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL