Class ExpiringKeyTracker<TKey>

Namespace

FishMMO.Server.Core.Collections

Assembly

FishMMO.Server.dll

Queue/index tracker for expiring keyed entries. Uses head-first sweeps to avoid full dictionary enumeration under heavy load.

public sealed class ExpiringKeyTracker<TKey>

Type Parameters

TKey

Tracker key type.

Inheritance

object

ExpiringKeyTracker<TKey>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ExpiringKeyTracker(IEqualityComparer<TKey>)

Initializes a new tracker with an optional key comparer.

public ExpiringKeyTracker(IEqualityComparer<TKey> comparer = null)

Parameters

comparer IEqualityComparer<TKey>

Properties

Count

Current number of tracked keys.

public int Count { get; }

Property Value

int

Methods

Clear()

Clears all tracked entries.

public void Clear()

Remove(TKey)

Removes a key from the tracker if present. Useful for cancelling a debounce window when the operation it was guarding has already failed and the caller wants to allow an immediate retry rather than make the user wait out the window.

public bool Remove(TKey key)

Parameters

key TKey

Tracker key to remove.

Returns

bool

true if the key existed and was removed; otherwise false.

SweepExpired(DateTime, int, int)

Sweeps expired keys with bounded scan and removal limits.

public int SweepExpired(DateTime nowUtc, int maxScan, int maxRemove)

Parameters

nowUtc DateTime

Current UTC timestamp.

maxScan int

Maximum queue nodes to inspect this sweep.

maxRemove int

Maximum keys to remove this sweep.

Returns

int

Number of entries removed.

TryBegin(TKey, DateTime, TimeSpan)

Attempts to begin a debounce/rate-limit window for a key.

public bool TryBegin(TKey key, DateTime nowUtc, TimeSpan duration)

Parameters

key TKey

Tracker key.

nowUtc DateTime

Current UTC timestamp.

duration TimeSpan

Window duration.

Returns

bool

true if allowed now; otherwise false.