pool

Documentation

Overview

Package pool manages a user defined set of resources.

Index

• Variables
• type Pool
  • func New(size uint, f func() (io.Closer, error)) (*Pool, error)
  • func (p *Pool) Acquire() (io.Closer, error)
  • func (p *Pool) Close() error
  • func (p *Pool) Release(r io.Closer)

Variables

var ErrPoolClosed = errors.New("Pool has been closed")

ErrPoolClosed is returned when an Acquire returns on a closed pool.

Types

type Pool

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

Pool manages a set of resources that can be shared safely by multiple goroutines. The resource being managed must implement the io.Closer interface.

func New

func New(size uint, f func() (io.Closer, error)) (*Pool, error)

New creates a pool that manages resources. A pool requires a function that can allocate a new resource and the size of the pool.

func (*Pool) Acquire

func (p *Pool) Acquire() (io.Closer, error)

Acquire retrieves a resource from the pool.

func (*Pool) Close

func (p *Pool) Close() error

Close will shutdown the pool and close all existing resources.

func (*Pool) Release

func (p *Pool) Release(r io.Closer)

Release places a new resource onto the pool.