idpool

Documentation

Overview

Package idpool implements a reusable integer id pool.

Example

pool := idpool.New(5,1024)
pool.Allocate() // 5
pool.Allocate() // 6
pool.Allocate(5)
pool.Allocate() // 5

Index

• type Pool
  • func New(low, high int) *Pool
  • func (p *Pool) Allocate() int
  • func (p *Pool) Clear()
  • func (p *Pool) High() int
  • func (p *Pool) Len() int
  • func (p *Pool) Low() int
  • func (p *Pool) Release(id int)
  • func (p *Pool) Reserve(id int)

Types

type Pool

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

Pool is the id pool.

func New

func New(low, high int) *Pool

New returns a new Pool for given range. Range [low,high) is left open and right closed. Setting high to 0 means high is MaxInt32.

func (*Pool) Allocate

func (p *Pool) Allocate() int

Allocate an id from the pool. Returns high if no id is available.

func (*Pool) Clear

func (p *Pool) Clear()

Clear the pool.

func (*Pool) High

func (p *Pool) High() int

High returns the high.

func (*Pool) Len

func (p *Pool) Len() int

Len returns the number of id reserved or allocated.

func (*Pool) Low

func (p *Pool) Low() int

Low returns the low.

func (*Pool) Release

func (p *Pool) Release(id int)

Release an id back to the pool. Do nothing if the id is outside of the range.

func (*Pool) Reserve

func (p *Pool) Reserve(id int)

Reserve an id from the pool.