gopool

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 22, 2026 License: MIT Imports: 4 Imported by: 0

README

gopool

有界动态工人池:Do 同步等待任务结束(适合事件 ACK)。

行为

  • 工人数在 [MinSize, MaxSize]:无空闲且未达上限时扩容;空闲超过 IdleTimeout 且高于下限时缩减。
  • 停池:取消 New(ctx) 的 ctx;工人退出,Do 返回 ErrPoolClosed。
  • 用法错误(New/Do 的 ctx 或 fn 为 nil)直接 panic,不允许带错运行。

示例

ctx, cancel := context.WithCancel(parent)
p := gopool.New(ctx, gopool.WithMinSize(2), gopool.WithMaxSize(8))
defer cancel()

err := p.Do(ctx, func(ctx context.Context) error {
    return handle(ctx)
})

Documentation

Overview

Package gopool 提供可动态扩缩的有界工人池。

Do 同步等待任务结束(便于调用方在结束后做 ACK 等收尾)。 工人数在 [MinSize, MaxSize] 之间:忙时扩容,空闲超时缩回 MinSize。 停池:取消 New 传入的 ctx。

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrPoolClosed = errors.New("gopool: closed")
)

Functions

This section is empty.

Types

type Option

type Option func(*Pool)

Option 配置 Pool。

func WithIdleTimeout

func WithIdleTimeout(d time.Duration) Option

WithIdleTimeout 空闲工人超过此时长且人数 > MinSize 时可回收。

func WithMaxSize

func WithMaxSize(n int) Option

WithMaxSize 设置最大工人数(至少等于 MinSize)。

func WithMinSize

func WithMinSize(n int) Option

WithMinSize 设置最小工人数(至少 1)。

type Pool

type Pool struct {
	// contains filtered or unexported fields
}

Pool 动态工人池。

func New

func New(ctx context.Context, opts ...Option) *Pool

New 创建池;生命周期跟随 ctx,取消即停池。ctx 必填(不可为 nil)。默认 min=2 max=8 idleTimeout=30s。

func (*Pool) Do

func (p *Pool) Do(ctx context.Context, fn func(context.Context) error) error

Do 在工人上执行 fn 并等待结果。无空闲且未达 max 时扩容;已满则阻塞等待工人。 ctx、fn 必填;为 nil 时 panic(用法错误)。

func (*Pool) MaxSize

func (p *Pool) MaxSize() int

MaxSize 最大工人数。

func (*Pool) MinSize

func (p *Pool) MinSize() int

MinSize 最小工人数。

func (*Pool) Size

func (p *Pool) Size() int

Size 当前工人数。

Jump to

Keyboard shortcuts

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