idm

Documentation

Overview

Package idm manages reservation/release of numerical ids from a configured set of contiguous ids.

Index

• Variables
• type IDM
  • func New(start, end uint) (*IDM, error)
  • func (i *IDM) GetID(serial bool) (uint, error)
  • func (i *IDM) GetSpecificID(id uint) error
  • func (i *IDM) Release(id uint)

Variables

var (
	// ErrNoBitAvailable is returned when no more bits are available to set
	ErrNoBitAvailable = errors.New("no bit available")
	// ErrBitAllocated is returned when the specific bit requested is already set
	ErrBitAllocated = errors.New("requested bit is already allocated")
)

Types

type IDM

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

IDM manages the reservation/release of numerical ids from a contiguous set.

An IDM instance is not safe for concurrent use.

func New

func New(start, end uint) (*IDM, error)

New returns an instance of id manager for a [start,end] set of numerical ids.

func (*IDM) GetID

func (i *IDM) GetID(serial bool) (uint, error)

GetID returns the first available id in the set.

func (*IDM) GetSpecificID

func (i *IDM) GetSpecificID(id uint) error

GetSpecificID tries to reserve the specified id.

func (*IDM) Release

func (i *IDM) Release(id uint)

Release releases the specified id.