grpool

Documentation

Overview

Package grpool implements a goroutine reusable pool.

Index

• func Add(ctx context.Context, f Func) error
• func AddWithRecover(ctx context.Context, userFunc Func, recoverFunc RecoverFunc) error
• func Jobs() int
• func Size() int
• type Func
• type Pool
  • func New(limit ...int) *Pool
  • func (p *Pool) Add(ctx context.Context, f Func) error
  • func (p *Pool) AddWithRecover(ctx context.Context, userFunc Func, recoverFunc RecoverFunc) error
  • func (p *Pool) Cap() int
  • func (p *Pool) Close()
  • func (p *Pool) IsClosed() bool
  • func (p *Pool) Jobs() int
  • func (p *Pool) Size() int
• type RecoverFunc

Functions

func Add

func Add(ctx context.Context, f Func) error

Add pushes a new job to the pool using default goroutine pool. The job will be executed asynchronously.

func AddWithRecover

func AddWithRecover(ctx context.Context, userFunc Func, recoverFunc RecoverFunc) error

AddWithRecover pushes a new job to the pool with specified recover function. The optional `recoverFunc` is called when any panic during executing of `userFunc`. If `recoverFunc` is not passed or given nil, it ignores the panic from `userFunc`. The job will be executed asynchronously.

func Jobs

func Jobs() int

Jobs returns current job count of default goroutine pool.

func Size

func Size() int

Size returns current goroutine count of default goroutine pool.

Types

type Func

type Func func(ctx context.Context)

Func is the pool function which contains context parameter.

type Pool

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

Pool manages the goroutines using pool.

func New

func New(limit ...int) *Pool

New creates and returns a new goroutine pool object. The parameter `limit` is used to limit the max goroutine count, which is not limited in default.

func (*Pool) Add

func (p *Pool) Add(ctx context.Context, f Func) error

Add pushes a new job to the pool. The job will be executed asynchronously.

func (*Pool) AddWithRecover

func (p *Pool) AddWithRecover(ctx context.Context, userFunc Func, recoverFunc RecoverFunc) error

AddWithRecover pushes a new job to the pool with specified recover function. The optional `recoverFunc` is called when any panic during executing of `userFunc`. If `recoverFunc` is not passed or given nil, it ignores the panic from `userFunc`. The job will be executed asynchronously.

func (*Pool) Cap

func (p *Pool) Cap() int

Cap returns the capacity of the pool. This capacity is defined when pool is created. It returns -1 if there's no limit.

func (*Pool) Close

func (p *Pool) Close()

Close closes the goroutine pool, which makes all goroutines exit.

func (*Pool) IsClosed

func (p *Pool) IsClosed() bool

IsClosed returns if pool is closed.

func (*Pool) Jobs

func (p *Pool) Jobs() int

Jobs returns current job count of the pool. Note that, it does not return worker/goroutine count but the job/task count.

func (*Pool) Size

func (p *Pool) Size() int

Size returns current goroutine count of the pool.

type RecoverFunc

type RecoverFunc func(ctx context.Context, err error)

RecoverFunc is the pool runtime panic recover function which contains context parameter.