chpool

Documentation

Index

• Variables
• type BadConnError
  • func (e BadConnError) Error() string
  • func (e BadConnError) Unwrap() error
• type Config
• type Conn
  • func NewConn(netConn net.Conn) *Conn
  • func (cn *Conn) Close() error
  • func (cn *Conn) Closed() bool
  • func (cn *Conn) LocalAddr() net.Addr
  • func (cn *Conn) Reader(ctx context.Context, timeout time.Duration) *chproto.Reader
  • func (cn *Conn) RemoteAddr() net.Addr
  • func (cn *Conn) SetUsedAt(tm time.Time)
  • func (cn *Conn) UsedAt() time.Time
  • func (cn *Conn) WithReader(ctx context.Context, timeout time.Duration, fn func(rd *chproto.Reader) error) error
  • func (cn *Conn) WithWriter(ctx context.Context, timeout time.Duration, fn func(wb *chproto.Writer)) error
• type ConnPool
  • func New(cfg *Config) *ConnPool
  • func (p *ConnPool) Close() error
  • func (p *ConnPool) CloseConn(cn *Conn) error
  • func (p *ConnPool) Get(ctx context.Context) (*Conn, error)
  • func (p *ConnPool) IdleLen() int
  • func (p *ConnPool) Len() int
  • func (p *ConnPool) NewConn(ctx context.Context) (*Conn, error)
  • func (p *ConnPool) Put(cn *Conn)
  • func (p *ConnPool) Remove(cn *Conn, reason error)
  • func (p *ConnPool) Stats() *Stats
• type Pooler
• type Stats

Variables

var (
	ErrClosed      = errors.New("ch: database is closed")
	ErrPoolTimeout = errors.New("ch: connection pool timeout")
)

Types

type BadConnError

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

func (BadConnError) Error

func (e BadConnError) Error() string

func (BadConnError) Unwrap

func (e BadConnError) Unwrap() error

type Config

type Config struct {
	Dialer  func(context.Context) (net.Conn, error)
	OnClose func(*Conn) error

	PoolSize        int
	PoolTimeout     time.Duration
	MaxIdleConns    int
	ConnMaxIdleTime time.Duration
	ConnMaxLifetime time.Duration
}

type Conn

type Conn struct {
	ServerInfo chproto.ServerInfo

	Inited bool
	// contains filtered or unexported fields
}

func NewConn

func NewConn(netConn net.Conn) *Conn

func (*Conn) Close

func (cn *Conn) Close() error

func (*Conn) Closed

func (cn *Conn) Closed() bool

func (*Conn) LocalAddr

func (cn *Conn) LocalAddr() net.Addr

func (*Conn) Reader

func (cn *Conn) Reader(ctx context.Context, timeout time.Duration) *chproto.Reader

func (*Conn) RemoteAddr

func (cn *Conn) RemoteAddr() net.Addr

func (*Conn) SetUsedAt

func (cn *Conn) SetUsedAt(tm time.Time)

func (*Conn) UsedAt

func (cn *Conn) UsedAt() time.Time

func (*Conn) WithReader

func (cn *Conn) WithReader(
	ctx context.Context,
	timeout time.Duration,
	fn func(rd *chproto.Reader) error,
) error

func (*Conn) WithWriter

func (cn *Conn) WithWriter(
	ctx context.Context,
	timeout time.Duration,
	fn func(wb *chproto.Writer),
) error

type ConnPool

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

func New

func New(cfg *Config) *ConnPool

func (*ConnPool) Close

func (p *ConnPool) Close() error

func (*ConnPool) CloseConn

func (p *ConnPool) CloseConn(cn *Conn) error

func (*ConnPool) Get

func (p *ConnPool) Get(ctx context.Context) (*Conn, error)

Get returns an existing connection from the pool or creates a new one.

func (*ConnPool) IdleLen

func (p *ConnPool) IdleLen() int

IdleLen returns number of idle connections.

func (*ConnPool) Len

func (p *ConnPool) Len() int

Len returns total number of connections.

func (*ConnPool) NewConn

func (p *ConnPool) NewConn(ctx context.Context) (*Conn, error)

func (*ConnPool) Put

func (p *ConnPool) Put(cn *Conn)

func (*ConnPool) Remove

func (p *ConnPool) Remove(cn *Conn, reason error)

func (*ConnPool) Stats

func (p *ConnPool) Stats() *Stats

type Pooler

type Pooler interface {
	NewConn(context.Context) (*Conn, error)
	CloseConn(*Conn) error

	Get(context.Context) (*Conn, error)
	Put(*Conn)
	Remove(*Conn, error)

	Len() int
	IdleLen() int
	Stats() *Stats

	Close() error
}

type Stats

type Stats struct {
	Hits     uint32 // number of times free connection was found in the pool
	Misses   uint32 // number of times free connection was NOT found in the pool
	Timeouts uint32 // number of times a wait timeout occurred

	TotalConns uint32 // number of total connections in the pool
	IdleConns  uint32 // number of idle connections in the pool
	StaleConns uint32 // number of stale connections removed from the pool
}

Stats contains pool state information and accumulated stats.