package pool

Import Path
	github.com/redis/go-redis/v9/internal/pool (on go.dev)

Dependency Relation
	imports 12 packages, and imported by one package

Involved Source Files

	    conn.go
	    conn_check.go
	    pool.go
	    pool_single.go
	    pool_sticky.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type BadConnError (struct)

		Methods (total 2)
			( BadConnError) Error() string
			( BadConnError) Unwrap() error
		Implements (at least 2)
			 BadConnError : error
			 BadConnError : golang.org/x/xerrors.Wrapper

	 type Conn (struct)

		Fields (only one)
			Inited bool
		Methods (total 8)
			(*Conn) Close() error
			(*Conn) RemoteAddr() net.Addr
			(*Conn) SetNetConn(netConn net.Conn)
			(*Conn) SetUsedAt(tm time.Time)
			(*Conn) UsedAt() time.Time
			(*Conn) WithReader(ctx context.Context, timeout time.Duration, fn func(rd *proto.Reader) error) error
			(*Conn) WithWriter(ctx context.Context, timeout time.Duration, fn func(wr *proto.Writer) error) error
			(*Conn) Write(b []byte) (int, error)
		Implements (at least 6)
			*Conn : github.com/miekg/dns.Writer
			*Conn : github.com/prometheus/common/expfmt.Closer
			*Conn : internal/bisect.Writer
			*Conn : io.Closer
			*Conn : io.WriteCloser
			*Conn : io.Writer
		As Outputs Of (at least 9)
			func NewConn(netConn net.Conn) *Conn
			func (*ConnPool).Get(ctx context.Context) (*Conn, error)
			func (*ConnPool).NewConn(ctx context.Context) (*Conn, error)
			func Pooler.Get(context.Context) (*Conn, error)
			func Pooler.NewConn(context.Context) (*Conn, error)
			func (*SingleConnPool).Get(ctx context.Context) (*Conn, error)
			func (*SingleConnPool).NewConn(ctx context.Context) (*Conn, error)
			func (*StickyConnPool).Get(ctx context.Context) (*Conn, error)
			func (*StickyConnPool).NewConn(ctx context.Context) (*Conn, error)
		As Inputs Of (at least 13)
			func NewSingleConnPool(pool Pooler, cn *Conn) *SingleConnPool
			func (*ConnPool).CloseConn(cn *Conn) error
			func (*ConnPool).Put(ctx context.Context, cn *Conn)
			func (*ConnPool).Remove(_ context.Context, cn *Conn, reason error)
			func Pooler.CloseConn(*Conn) error
			func Pooler.Put(context.Context, *Conn)
			func Pooler.Remove(context.Context, *Conn, error)
			func (*SingleConnPool).CloseConn(cn *Conn) error
			func (*SingleConnPool).Put(ctx context.Context, cn *Conn)
			func (*SingleConnPool).Remove(ctx context.Context, cn *Conn, reason error)
			func (*StickyConnPool).CloseConn(cn *Conn) error
			func (*StickyConnPool).Put(ctx context.Context, cn *Conn)
			func (*StickyConnPool).Remove(ctx context.Context, cn *Conn, reason error)

	 type ConnPool (struct)

		Methods (total 10)
			(*ConnPool) Close() error
			(*ConnPool) CloseConn(cn *Conn) error
			(*ConnPool) Filter(fn func(*Conn) bool) error
			(*ConnPool) Get(ctx context.Context) (*Conn, error)
				Get returns existed connection from the pool or creates a new one.

			(*ConnPool) IdleLen() int
				IdleLen returns number of idle connections.

			(*ConnPool) Len() int
				Len returns total number of connections.

			(*ConnPool) NewConn(ctx context.Context) (*Conn, error)
			(*ConnPool) Put(ctx context.Context, cn *Conn)
			(*ConnPool) Remove(_ context.Context, cn *Conn, reason error)
			(*ConnPool) Stats() *Stats
		Implements (at least 3)
			*ConnPool : Pooler
			*ConnPool : github.com/prometheus/common/expfmt.Closer
			*ConnPool : io.Closer
		As Outputs Of (at least one exported)
			func NewConnPool(opt *Options) *ConnPool

	 type Options (struct)

		Fields (total 8)
			ConnMaxIdleTime time.Duration
			ConnMaxLifetime time.Duration
			Dialer func(context.Context) (net.Conn, error)
			MaxIdleConns int
			MinIdleConns int
			PoolFIFO bool
			PoolSize int
			PoolTimeout time.Duration
		As Inputs Of (at least one exported)
			func NewConnPool(opt *Options) *ConnPool

	 type Pooler (interface)

		Methods (total 9)
			( Pooler) Close() error
			( Pooler) CloseConn(*Conn) error
			( Pooler) Get(context.Context) (*Conn, error)
			( Pooler) IdleLen() int
			( Pooler) Len() int
			( Pooler) NewConn(context.Context) (*Conn, error)
			( Pooler) Put(context.Context, *Conn)
			( Pooler) Remove(context.Context, *Conn, error)
			( Pooler) Stats() *Stats
		Implemented By (at least 3)
			*ConnPool
			*SingleConnPool
			*StickyConnPool
		Implements (at least 2)
			 Pooler : github.com/prometheus/common/expfmt.Closer
			 Pooler : io.Closer
		As Inputs Of (at least 2)
			func NewSingleConnPool(pool Pooler, cn *Conn) *SingleConnPool
			func NewStickyConnPool(pool Pooler) *StickyConnPool

	 type SingleConnPool (struct)

		Methods (total 9)
			(*SingleConnPool) Close() error
			(*SingleConnPool) CloseConn(cn *Conn) error
			(*SingleConnPool) Get(ctx context.Context) (*Conn, error)
			(*SingleConnPool) IdleLen() int
			(*SingleConnPool) Len() int
			(*SingleConnPool) NewConn(ctx context.Context) (*Conn, error)
			(*SingleConnPool) Put(ctx context.Context, cn *Conn)
			(*SingleConnPool) Remove(ctx context.Context, cn *Conn, reason error)
			(*SingleConnPool) Stats() *Stats
		Implements (at least 3)
			*SingleConnPool : Pooler
			*SingleConnPool : github.com/prometheus/common/expfmt.Closer
			*SingleConnPool : io.Closer
		As Outputs Of (at least one exported)
			func NewSingleConnPool(pool Pooler, cn *Conn) *SingleConnPool

	 type Stats (struct)
		Stats contains pool state information and accumulated stats.

		Fields (total 6)
			Hits uint32
				// number of times free connection was found in the pool

			IdleConns uint32
				// number of idle connections in the pool

			Misses uint32
				// number of times free connection was NOT found in the pool

			StaleConns uint32
				// number of stale connections removed from the pool

			Timeouts uint32
				// number of times a wait timeout occurred

			TotalConns uint32
				// number of total connections in the pool

		As Outputs Of (at least 4)
			func (*ConnPool).Stats() *Stats
			func Pooler.Stats() *Stats
			func (*SingleConnPool).Stats() *Stats
			func (*StickyConnPool).Stats() *Stats

	 type StickyConnPool (struct)

		Methods (total 10)
			(*StickyConnPool) Close() error
			(*StickyConnPool) CloseConn(cn *Conn) error
			(*StickyConnPool) Get(ctx context.Context) (*Conn, error)
			(*StickyConnPool) IdleLen() int
			(*StickyConnPool) Len() int
			(*StickyConnPool) NewConn(ctx context.Context) (*Conn, error)
			(*StickyConnPool) Put(ctx context.Context, cn *Conn)
			(*StickyConnPool) Remove(ctx context.Context, cn *Conn, reason error)
			(*StickyConnPool) Reset(ctx context.Context) error
			(*StickyConnPool) Stats() *Stats
		Implements (at least 3)
			*StickyConnPool : Pooler
			*StickyConnPool : github.com/prometheus/common/expfmt.Closer
			*StickyConnPool : io.Closer
		As Outputs Of (at least one exported)
			func NewStickyConnPool(pool Pooler) *StickyConnPool


Package-Level Functions (total 4)

	 func NewConn(netConn net.Conn) *Conn
	 func NewConnPool(opt *Options) *ConnPool
	 func NewSingleConnPool(pool Pooler, cn *Conn) *SingleConnPool
	 func NewStickyConnPool(pool Pooler) *StickyConnPool
Package-Level Variables (total 2)

	  var ErrClosed error
		ErrClosed performs any operation on the closed client will return this error.

	  var ErrPoolTimeout error
		ErrPoolTimeout timed out waiting to get a connection from the connection pool.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.