pool

Documentation

Overview

Package pool is a connection pool

Index

• type Conn
• type Option
  • func Size(i int) Option
  • func TTL(t time.Duration) Option
  • func Transport(t transport.Transport) Option
• type Options
• type Pool
  • func NewPool(opts ...Option) Pool

Types

type Conn

type Conn interface {
	// unique id of connection
	ID() string
	// time it was created
	Created() time.Time
	// embedded connection
	transport.Client
}

Conn conn pool interface

type Option

type Option func(*Options)

Option func signature

func Size

func Size(i int) Option

Size sets the size

func TTL

func TTL(t time.Duration) Option

TTL specifies ttl

func Transport

func Transport(t transport.Transport) Option

Transport sets the transport

type Options

type Options struct {
	Transport transport.Transport
	TTL       time.Duration
	Size      int
}

Options struct

type Pool

type Pool interface {
	// Close the pool
	Close() error
	// Get a connection
	Get(ctx context.Context, addr string, opts ...transport.DialOption) (Conn, error)
	// Release the connection
	Release(c Conn, status error) error
}

Pool is an interface for connection pooling

func NewPool

func NewPool(opts ...Option) Pool

NewPool creates new connection pool