pool

README

Byte buffer pool

Documentation

Index

• Variables
• type Entry
• type Pool
  • func New(l uint64) *Pool
  • func (p *Pool) Get(size uint64) ([]byte, error)
  • func (p *Pool) Put(buffer []byte) error
  • func (p *Pool) Size() uint64
  • func (p *Pool) Usage() Usage
• type Usage

Variables

var (
	ErrPoolLimitReached = errors.New("pool limit reached")
	ErrNilBuffer        = errors.New("cannot put nil-buffer into pool")
	ErrNoPoolBuffer     = errors.New("buffer was not taken from pool")
)

Some errors returned by the Put method.

Types

type Entry

type Entry struct {
	Used  int
	Count int
}

Entry defines a usage entry.

type Pool

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

Pool deinfes the byte buffer pool.

func New

func New(l uint64) *Pool

New returns a new bytes buffer pool with the provided size limit.

func (*Pool) Get

func (p *Pool) Get(size uint64) ([]byte, error)

Get returns a buffer of the provided size.

func (*Pool) Put

func (p *Pool) Put(buffer []byte) error

Put places the provided buffer back in the pool.

func (*Pool) Size

func (p *Pool) Size() uint64

Size returns the size of the byte buffer pool.

func (*Pool) Usage

func (p *Pool) Usage() Usage

Usage returns a map with counts of all sizes.

type Usage

type Usage map[uint64]Entry

Usage defines a container map where usage information about the buffer usage is stored.