pool

Documentation

Index

• Variables
• type Executor
• type Factory
• type Option
  • func IdleTimeout(idle time.Duration) Option
  • func InitialCap(cap int) Option
  • func MaxCap(cap int) Option
  • func MaxIdle(idle int) Option
  • func OptionClose(f Executor) Option
  • func OptionFactory(f Factory) Option
  • func OptionPing(f Executor) Option
• type Options
• type Pool
  • func NewPool(opts ...Option) (Pool, error)

Variables

var (
	ErrPoolClosed     = errcode.New("pool is closed")
	ErrNilFactory     = errcode.New("nil factory")
	ErrOpenedMaxConns = errcode.New("opened the maximum conns")
	ErrNilCloseFunc   = errcode.New("nil close function")
	ErrNilConnection  = errcode.New("nil connection")
	ErrGetConnTimeout = errcode.New("timeout to get connection")
)

Types

type Executor

type Executor func(interface{}) error

type Factory

type Factory func() (interface{}, error)

type Option

type Option func(*Options)

func IdleTimeout

func IdleTimeout(idle time.Duration) Option

func InitialCap

func InitialCap(cap int) Option

func MaxCap

func MaxCap(cap int) Option

func MaxIdle

func MaxIdle(idle int) Option

func OptionClose

func OptionClose(f Executor) Option

func OptionFactory

func OptionFactory(f Factory) Option

func OptionPing

func OptionPing(f Executor) Option

type Options

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

type Pool

type Pool interface {
	Get() (interface{}, error)

	Put(interface{}) error

	Close(interface{}) error

	Release()

	Len() int
}

Pool interface describes a pool implementation. A pool should have maximum capacity. An ideal pool is threadsafe and easy to use.

func NewPool

func NewPool(opts ...Option) (Pool, error)