pools

Documentation

Index

• Variables
• func AcquireTimer(timeout time.Duration) *time.Timer
• func AcquireWaitGroup() *sync.WaitGroup
• func ReleaseTimer(t *time.Timer)
• func ReleaseWaitGroup(wg *sync.WaitGroup)
• func ResetTimer(t *time.Timer, period time.Duration)
• type Pool
  • func New(min, max int) *Pool
  • func (p *Pool) Get(n, c int) []byte
  • func (p *Pool) GetCap(c int) []byte
  • func (p *Pool) GetLen(n int) []byte
  • func (p *Pool) Put(bts []byte)

Variables

var Bytes = New(32, 64*(1<<10))

var TinyBytes = New(4, 128)

Functions

func AcquireTimer

func AcquireTimer(timeout time.Duration) *time.Timer

func AcquireWaitGroup

func AcquireWaitGroup() *sync.WaitGroup

func ReleaseTimer

func ReleaseTimer(t *time.Timer)

func ReleaseWaitGroup

func ReleaseWaitGroup(wg *sync.WaitGroup)

func ResetTimer

func ResetTimer(t *time.Timer, period time.Duration)

Types

type Pool

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

Pool contains logic of reusing objects distinguishable by size in generic way.

func New

func New(min, max int) *Pool

New creates new Pool that reuses objects which size is in logarithmic range [min, max].

Note that it is a shortcut for Custom() constructor with Options provided by WithLogSizeMapping() and WithLogSizeRange(min, max) calls.

func (*Pool) Get

func (p *Pool) Get(n, c int) []byte

Get returns probably reused slice of bytes with at least capacity of c and exactly len of n.

func (*Pool) GetCap

func (p *Pool) GetCap(c int) []byte

GetCap returns probably reused slice of bytes with at least capacity of n.

func (*Pool) GetLen

func (p *Pool) GetLen(n int) []byte

GetLen returns probably reused slice of bytes with at least capacity of n and exactly len of n.

func (*Pool) Put

func (p *Pool) Put(bts []byte)

Put returns given slice to reuse pool. It does not reuse bytes whose size is not power of two or is out of pool min/max range.