Class FailureBudget<TKey>

Namespace

The.Utility

Assembly

Instagile.dll

A token budget for each key, billed only after a failure is observed, refilling at one token per Period up to Burst.

public sealed class FailureBudget<TKey> where TKey : notnull

Type Parameters

TKey

Inheritance

object

FailureBudget<TKey>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

System.Threading.RateLimiting can't do this: its leases are acquired before the outcome is known. A balance can go negative, in which case in-flight failures must be drained before the key is allowed again.

Constructors

FailureBudget(RateLimit)

A token budget for each key, billed only after a failure is observed, refilling at one token per Period up to Burst.

public FailureBudget(RateLimit limit)

Parameters

limit RateLimit

Remarks

System.Threading.RateLimiting can't do this: its leases are acquired before the outcome is known. A balance can go negative, in which case in-flight failures must be drained before the key is allowed again.

Methods

Charge(TKey)

Bill one failure to the key.

public void Charge(TKey key)

Parameters

key TKey

IsAllowed(TKey)

True if the key has not exhausted its budget.

public bool IsAllowed(TKey key)

Parameters

key TKey

Returns

bool