pool

package

v0.0.78 Latest Latest Go to latest Published: May 7, 2022 License: MIT Imports: 5 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type EmptyPoolOptions struct{}

EmptyPoolUrlOption does not alter the Pooluration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

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

func New(taskFunc TaskHandler, opts ...PoolOptions) *Pool

func (o *Pool) ApplyOptions(options ...PoolOptions) *Pool

func (p *Pool) Error() error

func (p *Pool) Put(task interface{}) error

func (p *Pool) Stop()

func (p *Pool) Wait()

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

type PoolOptions interface {
	// contains filtered or unexported methods
}

A PoolOptions sets options.

func WithBurst(burst int) PoolOptions

func WithErrStop(errStop bool) PoolOptions

type PoolOptionsFunc func(*Pool)

PoolOptionsFunc wraps a function that modifies Pool into an implementation of the PoolOptions interface.

type TaskHandler func(task interface{}) error

type WorkFunc func(work interface{}) error

type Worker struct {
	Burst int32
	// contains filtered or unexported fields
}

func (w *Worker) Error() error

func (w *Worker) Stop()

func (w *Worker) TrySetError(err error)

func (w *Worker) Wait()

func (w *Worker) Work(
	ctx context.Context,
	workChan <-chan interface{},
	workFn WorkFunc,
	errStop bool,
) (doneC <-chan struct{})