pool

Documentation

Index

• Variables
• type Conn
  • func NewConn(client ldap.Client) *Conn
  • func (cn *Conn) SetUsedAt(tm time.Time)
  • func (cn *Conn) UsedAt() time.Time
• type ConnPool
  • func NewPool(opt *Options) *ConnPool
  • func (p *ConnPool) Close() error
  • func (p *ConnPool) CloseConn(cn *Conn)
  • func (p *ConnPool) Filter(fn func(*Conn) bool)
  • func (p *ConnPool) Get() (*Conn, error)
  • func (p *ConnPool) IdleLen() int
  • func (p *ConnPool) Len() int
  • func (p *ConnPool) Put(cn *Conn)
  • func (p *ConnPool) Remove(cn *Conn)
  • func (p *ConnPool) Stats() *Stats
• type Options
• type Pooler
• type Stats

Variables

var (
	ErrClosed      = errors.New("client is closed")
	ErrPoolTimeout = errors.New("connection pool timeout")
)

vars

Types

type Conn

type Conn struct {
	ldap.Client
	// contains filtered or unexported fields
}

Conn ...

func NewConn

func NewConn(client ldap.Client) *Conn

NewConn ...

func (*Conn) SetUsedAt

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

SetUsedAt ...

func (*Conn) UsedAt

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

UsedAt ...

type ConnPool

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

ConnPool ...

func NewPool

func NewPool(opt *Options) *ConnPool

NewPool ...

func (*ConnPool) Close

func (p *ConnPool) Close() error

Close ...

func (*ConnPool) CloseConn

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

CloseConn ...

func (*ConnPool) Filter

func (p *ConnPool) Filter(fn func(*Conn) bool)

Filter ...

func (*ConnPool) Get

func (p *ConnPool) Get() (*Conn, error)

Get returns existed 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) Put

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

Put ...

func (*ConnPool) Remove

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

Remove ...

func (*ConnPool) Stats

func (p *ConnPool) Stats() *Stats

Stats ...

type Options

type Options struct {
	Factory func() (ldap.Client, error)
	OnClose func(*Conn) error

	PoolSize           int
	MinIdleConns       int
	MaxConnAge         time.Duration
	PoolTimeout        time.Duration
	IdleTimeout        time.Duration
	IdleCheckFrequency time.Duration
}

Options ...

type Pooler

type Pooler interface {
	Get() (*Conn, error)
	Put(c *Conn)

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

	Close() error
}

Pooler ...

type Stats

type Stats struct {
	Hits     uint32 `json:"hits"`     // number of times free connection was found in the pool
	Misses   uint32 `json:"misses"`   // number of times free connection was NOT found in the pool
	Timeouts uint32 `json:"timeouts"` // number of times a wait timeout occurred

	TotalConns uint32 `json:"totalConns"` // number of total connections in the pool
	IdleConns  uint32 `json:"idelConns"`  // number of idle connections in the pool
	StaleConns uint32 `json:"staleConns"` // number of stale connections removed from the pool
}

Stats contains pool state information and accumulated stats.