Documentation
¶
Index ¶
- Variables
- type PriorityQueue
- type Staleness
- func (s *Staleness[T]) Delete(id identity.Stream)
- func (s *Staleness[T]) Evict() identity.Stream
- func (s *Staleness[T]) ExpireOldEntries()
- func (s *Staleness[T]) Items() func(yield func(identity.Stream, T) bool) bool
- func (s *Staleness[T]) Len() int
- func (s *Staleness[T]) Load(id identity.Stream) (T, bool)
- func (s *Staleness[T]) Next() time.Time
- func (s *Staleness[T]) Store(id identity.Stream, v T) error
Constants ¶
This section is empty.
Variables ¶
var NowFunc = time.Now
We override how Now() is returned, so we can have deterministic tests
Functions ¶
This section is empty.
Types ¶
type PriorityQueue ¶
type PriorityQueue interface {
// Update will add or update an entry, and reshuffle the queue internally as needed to keep it sorted
Update(id identity.Stream, newPrio time.Time)
// Peek will return the entry at the HEAD of the queue *without* removing it from the queue
Peek() (identity.Stream, time.Time)
// Pop will remove the entry at the HEAD of the queue and return it
Pop() (identity.Stream, time.Time)
// Len will return the number of entries in the queue
Len() int
}
PriorityQueue represents a way to store entries sorted by their priority. Pop() will return the oldest entry of the set.
func NewPriorityQueue ¶
func NewPriorityQueue() PriorityQueue
type Staleness ¶
Staleness a a wrapper over a map that adds an additional "staleness" value to each entry. Users can call ExpireOldEntries() to automatically remove all entries from the map whole staleness value is older than the `max`
NOTE: Staleness methods are *not* thread-safe. If the user needs to use Staleness in a multi-threaded environment, then it is the user's responsibility to properly serialize calls to Staleness methods
func (*Staleness[T]) ExpireOldEntries ¶
func (s *Staleness[T]) ExpireOldEntries()
ExpireOldEntries will remove all entries whose staleness value is older than `now() - max` For example, if an entry has a staleness value of two hours ago, and max == 1 hour, then the entry would be removed. But if an entry had a stalness value of 30 minutes, then it *wouldn't* be removed.
func (*Staleness[T]) Items ¶
Items returns an iterator function that in future go version can be used with range See: https://go.dev/wiki/RangefuncExperiment
Source Files