dgpool

Documentation

Index

• Constants
• Variables
• func Add(f func()) error
• func AddWithRecover(userFunc func(), recoverFunc ...func(err error)) error
• func AddWithSyncFunc(useFunc func(), syncFunc func(bool)) error
• func FILOAnywayGo(fn func())
• func FILOGo(fn func()) bool
• func FILOMustGo(fn func(), ctx ...context.Context) error
• func FILOTryGo(fn func())
• func Go(fn func()) bool
• func Jobs() int
• func SetFILOPool(maxGoroutinesAmount int, maxGoroutineIdleDuration time.Duration)
• func Size() int
• type FILOPool
  • func NewFILOPool(maxGoroutinesAmount int, maxGoroutineIdleDuration time.Duration) *FILOPool
  • func (that *FILOPool) Go(fn func()) error
  • func (that *FILOPool) MaxGoroutineIdle() time.Duration
  • func (that *FILOPool) MaxGoroutinesAmount() int
  • func (that *FILOPool) MustGo(fn func(), ctx ...context.Context) error
  • func (that *FILOPool) Stop()
  • func (that *FILOPool) TryGo(fn func())
• type Pool
  • func New(limit ...int) *Pool
  • func (that *Pool) Add(f func()) error
  • func (that *Pool) AddWithRecover(useFunc func(), recoverFunc ...func(err error)) error
  • func (that *Pool) AddWithSyncFunc(useFunc func(), syncFunc func(bool)) error
  • func (that *Pool) Cap() int
  • func (that *Pool) Close()
  • func (that *Pool) IsClosed() bool
  • func (that *Pool) Jobs() int
  • func (that *Pool) Size() int

Constants

const (
	// DefaultMaxGoroutinesAmount 默认的协程最大数量
	DefaultMaxGoroutinesAmount = 256 * 1024
	// DefaultMaxGoroutineIdleDuration 默认协程最大空闲时间
	DefaultMaxGoroutineIdleDuration = 10 * time.Second
)

Variables

var ErrLack = errors.New("lack of goroutines, because exceeded maxGoroutinesAmount limit")

Functions

func Add

func Add(f func()) error

Add 往默认协程池中添加jobs

func AddWithRecover

func AddWithRecover(userFunc func(), recoverFunc ...func(err error)) error

AddWithRecover 在默认协程池中执行方法，并且执行完成后，如果出错，则调用recover方法

func AddWithSyncFunc

func AddWithSyncFunc(useFunc func(), syncFunc func(bool)) error

AddWithSyncFunc 在默认协程池中执行方法，执行完成后回调

func FILOAnywayGo

func FILOAnywayGo(fn func())

FILOAnywayGo 强制执行方法

func FILOGo

func FILOGo(fn func()) bool

FILOGo 使用栈的形式组织协程执行方法，

func FILOMustGo

func FILOMustGo(fn func(), ctx ...context.Context) error

FILOMustGo 强制执行方法，并且传入上下文

func FILOTryGo

func FILOTryGo(fn func())

FILOTryGo 尝试执行方法

func Go

func Go(fn func()) bool

Go 执行协程

func Jobs

func Jobs() int

Jobs 默认协程池当前中有多少个任务需要执行

func SetFILOPool

func SetFILOPool(maxGoroutinesAmount int, maxGoroutineIdleDuration time.Duration)

func Size

func Size() int

Size 默认协程池的大小

Types

type FILOPool

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

func NewFILOPool

func NewFILOPool(maxGoroutinesAmount int, maxGoroutineIdleDuration time.Duration) *FILOPool

NewFILOPool 创建协程栈池

func (*FILOPool) Go

func (that *FILOPool) Go(fn func()) error

Go 通过 goroutine 执行方法，如果返回值不为nil，则表示超过了最大执行个数

func (*FILOPool) MaxGoroutineIdle

func (that *FILOPool) MaxGoroutineIdle() time.Duration

func (*FILOPool) MaxGoroutinesAmount

func (that *FILOPool) MaxGoroutinesAmount() int

func (*FILOPool) MustGo

func (that *FILOPool) MustGo(fn func(), ctx ...context.Context) error

MustGo 强制执行方法，直到执行完毕，或者上下文取消

func (*FILOPool) Stop

func (that *FILOPool) Stop()

func (*FILOPool) TryGo

func (that *FILOPool) TryGo(fn func())

TryGo 尝试通过goroutine执行方法，如果不成功，则同步执行

type Pool

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

Pool Goroutine Pool

func New

func New(limit ...int) *Pool

New 创建协程池，limit限制最多能同时运行多少个工作协程

func (*Pool) Add

func (that *Pool) Add(f func()) error

Add 添加待执行的方法到协程池

func (*Pool) AddWithRecover

func (that *Pool) AddWithRecover(useFunc func(), recoverFunc ...func(err error)) error

AddWithRecover 添加任务，并在任务执行出错的情况下，回调recoverFunc

func (*Pool) AddWithSyncFunc

func (that *Pool) AddWithSyncFunc(useFunc func(), syncFunc func(bool)) error

AddWithSyncFunc 执行成功后回调方法

func (*Pool) Cap

func (that *Pool) Cap() int

Cap 协程池最大能够启动多少个协程

func (*Pool) Close

func (that *Pool) Close()

Close 关闭协程池

func (*Pool) IsClosed

func (that *Pool) IsClosed() bool

IsClosed 判断协程池是否关闭

func (*Pool) Jobs

func (that *Pool) Jobs() int

Jobs 协程池中的待执行任务数量

func (*Pool) Size

func (that *Pool) Size() int

Size 协程池中的协程数量