pool

package

v0.1.928 Latest Latest Go to latest Published: Feb 6, 2026 License: Apache-2.0 Imports: 3 Imported by: 1

Details

This section is empty.

This section is empty.

This section is empty.

type Client interface {
	contract.PoolOperator
}

func NewClient(opts ClientOptions) Client

type ClientOption = contract.Opt[ClientOptions]

func WithConcurrency(x int) ClientOption

type ClientOptions struct {
	Concurrency int
}

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool struct {
	T *contract.Tool[Client]
}

func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool

func (d *DefaultTool) Acquire(ctx context.Context) error

Acquire reserves a worker slot in the pool.

func (d *DefaultTool) ActiveWorkers(ctx context.Context) (int, error)

ActiveWorkers returns the number of currently active workers.

func (d *DefaultTool) CloneWithConcurrency(ctx context.Context, x int) (contract.PoolOperator, error)

CloneWithConcurrency creates a new clone with the specified concurrency level.

func (d *DefaultTool) Release(ctx context.Context) error

Release frees a worker slot in the pool.

func (d *DefaultTool) Shutdown(ctx context.Context) error

Shutdown gracefully shuts down the worker pool, preventing new workers from being added.

func (d *DefaultTool) WaitAll(ctx context.Context) error

WaitAll blocks until all workers have completed their tasks.

type Tool interface {
	Client
}