PartitionedRateLimiter<TResource>.AcquireAsync Method

Reference

Definition

Namespace:: System.Threading.RateLimiting

Assembly:: System.Threading.RateLimiting.dll

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Package:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Source:: PartitionedRateLimiter.T.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public System.Threading.Tasks.ValueTask<System.Threading.RateLimiting.RateLimitLease> AcquireAsync (TResource resource, int permitCount = 1, System.Threading.CancellationToken cancellationToken = default);

member this.AcquireAsync : 'Resource * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Threading.RateLimiting.RateLimitLease>

Public Function AcquireAsync (resource As TResource, Optional permitCount As Integer = 1, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of RateLimitLease)

Parameters

resource: TResource

The resource to limit.

permitCount: Int32

Number of permits to try and acquire.

cancellationToken: CancellationToken

Optional token to allow canceling a queued request for permits.

Returns

ValueTask<RateLimitLease>

A task that completes when the requested permits are acquired or when the requested permits are denied.

Exceptions

ArgumentOutOfRangeException

Remarks

Set permitCount to 0 to wait until permits are replenished.

Applies to

Share via