pooling

Documentation

Overview

Package pooling implements the wayback workers pool.

Index

• Variables
• type Bucket
• type Option
  • func Capacity(c int) Option
  • func MaxRetries(r uint64) Option
  • func Timeout(t time.Duration) Option
• type Options
• type Pool
  • func New(ctx context.Context, options ...Option) *Pool
  • func (p *Pool) Close()
  • func (p *Pool) Closed() bool
  • func (p *Pool) Put(b Bucket)
  • func (p *Pool) Roll()
  • func (p *Pool) Status() Status
• type Status
  • func (s Status) String() string

Variables

var (
	ErrPoolNotExist = errors.New("pool not exist")  // ErrPoolNotExist pool not exist
	ErrTimeout      = errors.New("process timeout") // ErrTimeout process timeout

)

Types

type Bucket

type Bucket struct {
	// Request is the main func for handling wayback requests.
	Request func(context.Context) error

	// Fallback defines an optional func to return a failure response for the Request func.
	Fallback func(context.Context) error
	// contains filtered or unexported fields
}

A Bucket represents a wayback request is sent by a service.

type Option

type Option func(*Options)

Option is a function that modifies the provided Options instance.

func Capacity

func Capacity(c int) Option

Capacity returns an Option function that sets the capacity value for the Options. The given capacity value will be applied when the returned function is called.

func MaxRetries

func MaxRetries(r uint64) Option

MaxRetries returns an Option function that sets the maximum retries value for the Options. The given maximum retries value will be applied when the returned function is called.

func Timeout

func Timeout(t time.Duration) Option

Timeout returns an Option function that sets the timeout value for the Options. The given timeout value will be applied when the returned function is called.

type Options

type Options struct {
	Timeout    time.Duration // Timeout specifies the maximum amount of time to wait for an operation to complete.
	MaxRetries uint64        // MaxRetries specifies the maximum number of times to retry the operation in case of failure.
	Capacity   int           // Capacity specifies the maximum number of items that can be processed simultaneously.
}

Options represents configuration for pooling.

type Pool

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

Pool represents a pool of services.

func New

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

New a resource pool of the specified capacity Resources are created concurrently to save resource initialization time

func (*Pool) Close

func (p *Pool) Close()

Close closes the worker pool, and it is blocked until all workers are idle.

func (*Pool) Closed

func (p *Pool) Closed() bool

Closed returns whether the pooling is closed. It uses a select with a timeout of 3 seconds to check if the p.closed channel has been closed.

func (*Pool) Put

func (p *Pool) Put(b Bucket)

Put puts wayback requests to the resource pool

func (*Pool) Roll

func (p *Pool) Roll()

Roll process wayback requests from the resource pool for execution.

func (*Pool) Status

func (p *Pool) Status() Status

Status returns status of worker pool.

type Status

type Status int

const (
	StatusIdle Status = iota
	StatusBusy
)

func (Status) String

func (s Status) String() string

String returns description of status.