httppool

README

go http client pool

for example

defer httppool.Close()

client := httppool.Get(content.Background())
client.Request()
...

Documentation

Index

• Variables
• func Close() error
• func CloseClient(c *Client) error
• func IdleLen() int
• func Len() int
• func Put(c *Client)
• func Remove(c *Client, err error)
• type Client
  • func Get(ctx context.Context) (*Client, error)
  • func NewClient(client *http.Client) *Client
  • func (c *Client) Close() error
  • func (c *Client) Request(url, method string, header http.Header, body io.Reader) ([]byte, error)
  • func (c *Client) SetCreatedAt(tm time.Time)
  • func (c *Client) SetUsedAt(tm time.Time)
  • func (c *Client) UsedAt() time.Time
• type ClientPool
  • func NewClientPool(opt *Options) *ClientPool
  • func (p *ClientPool) Close() error
  • func (p *ClientPool) CloseClient(client *Client) error
  • func (p *ClientPool) Get(ctx context.Context) (*Client, error)
  • func (p *ClientPool) GetStats() *Stats
  • func (p *ClientPool) IdleLen() int
  • func (p *ClientPool) Len() int
  • func (p *ClientPool) NewClient(ctx context.Context) (*Client, error)
  • func (p *ClientPool) Put(client *Client)
  • func (p *ClientPool) ReapStaleClients() (int, error)
  • func (p *ClientPool) Remove(client *Client, reason error)
• type Options
• type Pooler
• type Stats
  • func GetStats() *Stats

Variables

var ErrClosed = errors.New("redis: client is closed")

var ErrPoolTimeout = errors.New("redis: connection pool timeout")

Functions

func Close

func Close() error

func CloseClient

func CloseClient(c *Client) error

func IdleLen

func IdleLen() int

func Len

func Len() int

func Put

func Put(c *Client)

func Remove

func Remove(c *Client, err error)

Types

type Client

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

func Get

func Get(ctx context.Context) (*Client, error)

func NewClient

func NewClient(client *http.Client) *Client

func (*Client) Close

func (c *Client) Close() error

func (*Client) Request

func (c *Client) Request(url, method string, header http.Header, body io.Reader) ([]byte, error)

func (*Client) SetCreatedAt

func (c *Client) SetCreatedAt(tm time.Time)

func (*Client) SetUsedAt

func (c *Client) SetUsedAt(tm time.Time)

func (*Client) UsedAt

func (c *Client) UsedAt() time.Time

type ClientPool

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

func NewClientPool

func NewClientPool(opt *Options) *ClientPool

func (*ClientPool) Close

func (p *ClientPool) Close() error

func (*ClientPool) CloseClient

func (p *ClientPool) CloseClient(client *Client) error

func (*ClientPool) Get

func (p *ClientPool) Get(ctx context.Context) (*Client, error)

func (*ClientPool) GetStats

func (p *ClientPool) GetStats() *Stats

func (*ClientPool) IdleLen

func (p *ClientPool) IdleLen() int

func (*ClientPool) Len

func (p *ClientPool) Len() int

func (*ClientPool) NewClient

func (p *ClientPool) NewClient(ctx context.Context) (*Client, error)

func (*ClientPool) Put

func (p *ClientPool) Put(client *Client)

func (*ClientPool) ReapStaleClients

func (p *ClientPool) ReapStaleClients() (int, error)

func (*ClientPool) Remove

func (p *ClientPool) Remove(client *Client, reason error)

type Options

type Options struct {
	Dialer  func(context.Context) (*http.Client, error)
	OnClose func(*Client) error

	PoolSize           int
	MinIdleClients     int
	MaxClientAge       time.Duration
	PoolTimeout        time.Duration
	IdleTimeout        time.Duration
	IdleCheckFrequency time.Duration
}

type Pooler

type Pooler interface {
	NewClient(context.Context) (*Client, error)
	CloseClient(*Client) error

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

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

	Close() error
}

type Stats

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

	TotalClients uint32 // number of total client in the pool
	IdleClients  uint32 // number of idle client in the pool
	StaleClients uint32 // number of stale client removed from the pool
}

Stats contains pool state information and accumulated stats.

func GetStats

func GetStats() *Stats