Class PartitionedShield<TKey>

Namespace

Kevlar

Assembly

Kevlar.dll

Selects and retains an independent untyped Shield for each partition key.

public sealed class PartitionedShield<TKey> : IDisposable, IAsyncDisposable where TKey : notnull

Type Parameters

TKey

Inheritance

object

PartitionedShield<TKey>

Implements

IDisposable

IAsyncDisposable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Retention is bounded by MaxPartitions. After the eviction callback and active executions complete, disposable strategies owned by an evicted shield are released. Shared strategy instances are disposed after their last partition owner. By default the provider owns every strategy returned by its factory; set OwnsStrategies to false when those instances are also used outside the provider. Do not reuse a shield after its partition is evicted. A later lookup creates a fresh partition with fresh strategy state. Partition keys are never added to metric tags or shield names automatically.

Constructors

PartitionedShield(Func<TKey, Shield>, PartitionedShieldOptions<TKey>?, IEqualityComparer<TKey>?)

Creates a bounded partition provider.

public PartitionedShield(Func<TKey, Shield> factory, PartitionedShieldOptions<TKey>? options = null, IEqualityComparer<TKey>? comparer = null)

Parameters

factory Func<TKey, Shield>

options PartitionedShieldOptions<TKey>

comparer IEqualityComparer<TKey>

Properties

CapacityEvictionCount

Gets the total number evicted to enforce the capacity bound.

public long CapacityEvictionCount { get; }

Property Value

long

ClearedEvictionCount

Gets the total number removed explicitly through remove or clear operations.

public long ClearedEvictionCount { get; }

Property Value

long

Count

Gets the current number of retained partitions.

public int Count { get; }

Property Value

int

CreatedCount

Gets the total number of partitions created by this provider.

public long CreatedCount { get; }

Property Value

long

EvictionCount

Gets the total number of partitions removed for any reason.

public long EvictionCount { get; }

Property Value

long

ExpirationEvictionCount

Gets the total number evicted after their idle expiration elapsed.

public long ExpirationEvictionCount { get; }

Property Value

long

Methods

Clear()

Removes every retained partition and begins configured lifecycle cleanup.

public void Clear()

ClearAsync()

Asynchronously removes every retained partition.

public ValueTask ClearAsync()

Returns

ValueTask

CreateAsync(Func<TKey, ValueTask<Shield>>, PartitionedShieldOptions<TKey>?, IEqualityComparer<TKey>?)

Creates a bounded partition provider with an asynchronous factory.

public static PartitionedShield<TKey> CreateAsync(Func<TKey, ValueTask<Shield>> factory, PartitionedShieldOptions<TKey>? options = null, IEqualityComparer<TKey>? comparer = null)

Parameters

factory Func<TKey, ValueTask<Shield>>

options PartitionedShieldOptions<TKey>

comparer IEqualityComparer<TKey>

Returns

PartitionedShield<TKey>

Dispose()

Disposes strategies owned by every retained partition.

public void Dispose()

DisposeAsync()

Asynchronously waits for in-flight factories, removals, and executions, then disposes strategies owned by every retained partition. Concurrent callers await the same disposal operation.

public ValueTask DisposeAsync()

Returns

ValueTask

GetShield(TKey)

Gets or creates the shield for key.

public Shield GetShield(TKey key)

Parameters

key TKey

Returns

Shield

GetShieldAsync(TKey)

Asynchronously gets or creates the shield for key.

public ValueTask<Shield> GetShieldAsync(TKey key)

Parameters

key TKey

Returns

ValueTask<Shield>

PruneExpired()

Removes partitions whose configured idle expiration has elapsed.

public int PruneExpired()

Returns

int

The number removed.

PruneExpiredAsync()

Asynchronously removes partitions whose idle expiration has elapsed.

public ValueTask<int> PruneExpiredAsync()

Returns

ValueTask<int>

TryGetShield(TKey, out Shield?)

Gets a retained shield without creating one.

public bool TryGetShield(TKey key, out Shield? shield)

Parameters

key TKey

shield Shield

Returns

bool

TryRemove(TKey)

Removes a retained partition and begins its configured lifecycle cleanup.

public bool TryRemove(TKey key)

Parameters

key TKey

Returns

bool

TryRemoveAsync(TKey)

Asynchronously removes a retained partition.

public ValueTask<bool> TryRemoveAsync(TKey key)

Parameters

key TKey

Returns

ValueTask<bool>