Share via

ConcurrencyLimiter Class

Definition

Namespace:
System.Threading.RateLimiting
Assembly:
System.Threading.RateLimiting.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0-preview.7.25380.108
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
ConcurrencyLimiter.cs

RateLimiter implementation that helps manage concurrent access to a resource.

public sealed class ConcurrencyLimiter : System.Threading.RateLimiting.RateLimiter
type ConcurrencyLimiter = class
    inherit RateLimiter
Public NotInheritable Class ConcurrencyLimiter
Inherits RateLimiter
Inheritance
Object
RateLimiter
ConcurrencyLimiter

Constructors

ConcurrencyLimiter(ConcurrencyLimiterOptions)

Initializes the ConcurrencyLimiter.

Properties

IdleDuration

Specifies how long the RateLimiter has had all permits available. Used by RateLimiter managers that may want to clean up unused RateLimiters.

Methods

AcquireAsync(Int32, CancellationToken)

Wait until the requested permits are available or permits can no longer be acquired.

(Inherited from RateLimiter)
AcquireAsyncCore(Int32, CancellationToken)

Method that RateLimiter implementations implement for AcquireAsync(Int32, CancellationToken).

(Inherited from RateLimiter)
AttemptAcquire(Int32)

Fast synchronous attempt to acquire permits.

(Inherited from RateLimiter)
AttemptAcquireCore(Int32)

Method that RateLimiter implementations implement for AttemptAcquire(Int32).

(Inherited from RateLimiter)
Dispose()

Disposes the RateLimiter. This completes any queued acquires with a failed lease.

(Inherited from RateLimiter)
Dispose(Boolean)

Dispose method for implementations to write.

(Inherited from RateLimiter)
DisposeAsync()

Disposes the RateLimiter asynchronously.

(Inherited from RateLimiter)
DisposeAsyncCore()

DisposeAsync method for implementations to write.

(Inherited from RateLimiter)
GetStatistics()

Gets a snapshot of the RateLimiter statistics if available.

Applies to