heropool

Documentation

Index

• Constants
• type EIndex
• type EjectionMode
• type Pool
  • func NewHeroPool(sizeLimit uint32, ejectionMode EjectionMode) *Pool
  • func (p *Pool) Add(entityId flow.Identifier, entity flow.Entity, owner uint64) (i EIndex, slotAvailable bool, ejectionOccurred bool)
  • func (p Pool) All() []PoolEntity
  • func (p Pool) Get(entityIndex EIndex) (flow.Identifier, flow.Entity, uint64)
  • func (p Pool) Head() (flow.Entity, bool)
  • func (p *Pool) Remove(sliceIndex EIndex)
  • func (p Pool) Size() uint32
• type PoolEntity
  • func (p PoolEntity) Entity() flow.Entity
  • func (p PoolEntity) Id() flow.Identifier

Constants

const (
	RandomEjection = EjectionMode("random-ejection")
	LRUEjection    = EjectionMode("lru-ejection")
	NoEjection     = EjectionMode("no-ejection")
)

Types

type EIndex

type EIndex uint32

EIndex is data type representing an entity index in Pool.

type EjectionMode

type EjectionMode string

type Pool

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

func NewHeroPool

func NewHeroPool(sizeLimit uint32, ejectionMode EjectionMode) *Pool

func (*Pool) Add

func (p *Pool) Add(entityId flow.Identifier, entity flow.Entity, owner uint64) (i EIndex, slotAvailable bool, ejectionOccurred bool)

Add writes given entity into a poolEntity on the underlying entities linked-list.

The first boolean return value (slotAvailable) says whether pool has an available slot. Pool goes out of available slots if it is full and no ejection is set.

If the pool has an available slot (either empty or by ejection), then the second boolean returned value (ejectionOccurred) determines whether an ejection happened to make one slot free or not. Ejection happens if there is no available slot, and there is an ejection mode set.

func (Pool) All

func (p Pool) All() []PoolEntity

All returns all stored entities in this pool.

func (Pool) Get

func (p Pool) Get(entityIndex EIndex) (flow.Identifier, flow.Entity, uint64)

Get returns entity corresponding to the entity index from the underlying list.

func (Pool) Head

func (p Pool) Head() (flow.Entity, bool)

Head returns the head of used items. Assuming no ejection happened and pool never goes beyond limit, Head returns the first inserted element.

func (*Pool) Remove

func (p *Pool) Remove(sliceIndex EIndex)

Remove removes entity corresponding to given getSliceIndex from the list.

func (Pool) Size

func (p Pool) Size() uint32

Size returns total number of entities that this list maintains.

type PoolEntity

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

func (PoolEntity) Entity

func (p PoolEntity) Entity() flow.Entity

func (PoolEntity) Id

func (p PoolEntity) Id() flow.Identifier