pool

Documentation

Index

• Variables
• type BytesPool
  • func NewBytesPool(minSize, maxSize int, factor float64, maxTotal uint64) (*BytesPool, error)
  • func (p *BytesPool) Get(sz int) (*[]byte, error)
  • func (p *BytesPool) Put(b *[]byte)

Variables

var ErrPoolExhausted = errors.New("pool exhausted")

ErrPoolExhausted is returned if a pool cannot provide the request bytes.

Types

type BytesPool

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

BytesPool is a bucketed pool for variably sized byte slices. It can be configured to not allow more than a maximum number of bytes being used at a given time. Every byte slice obtained from the pool must be returned.

func NewBytesPool

func NewBytesPool(minSize, maxSize int, factor float64, maxTotal uint64) (*BytesPool, error)

NewBytesPool returns a new BytesPool with size buckets for minSize to maxSize increasing by the given factor and maximum number of used bytes. No more than maxTotal bytes can be used at any given time unless maxTotal is set to 0.

func (*BytesPool) Get

func (p *BytesPool) Get(sz int) (*[]byte, error)

Get returns a new byte slices that fits the given size.

func (*BytesPool) Put

func (p *BytesPool) Put(b *[]byte)

Put returns a byte slice to the right bucket in the pool.