Interface IAgedQueue<TKey>

A data structure for selecting elements to expire in order

Type parameters

TKey

Hierarchy

IAgedQueue

Implemented by

FIFOAgedQueue

Index

Properties

compare

Methods

Properties

compare

compare: AgedCompareFunc

param ageA: The first age to compare
param ageB: The second age to compare
returns: 0 if same order, positive if ageA after ageB, negative if ageA before ageB

Methods

addOrReplace

addOrReplace(key: TKey, age?: number): void

- Defined in main/src/queue/IAgedQueue.ts:38
Parameters
- key: TKey
  
  The key to add
- Optional age: number
  
  The age if explicitly or default if undefined
Returns void

delete

delete(key: TKey): void

- Defined in main/src/queue/IAgedQueue.ts:48
Parameters
- key: TKey
  
  The key to delete
Returns void

getInitialAge

getInitialAge(key: TKey): number

- Defined in main/src/queue/IAgedQueue.ts:59
Parameters
- key: TKey
  
  The key we want a default for
Returns number
The default age that will very by algorithm

isNextExpired

isNextExpired(): boolean

- Defined in main/src/queue/IAgedQueue.ts:53
Returns boolean
True if the next key in order is expired and should be removed

next

next(): null | TKey

- Defined in main/src/queue/IAgedQueue.ts:43
Returns null | TKey
The next key in order or null if there is no key

size

size(): number

- Defined in main/src/queue/IAgedQueue.ts:76
Returns number
The number of keys in the queue

updateAge

updateAge(key: TKey): void

- Defined in main/src/queue/IAgedQueue.ts:64
Parameters
- key: TKey
  
  Advance the age of the specified key
Returns void

Generated using TypeDoc