PartitionedRateLimiter<TResource>.AcquireAsyncCore 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

Method that PartitionedRateLimiter<TResource> implementations implement for AcquireAsync(TResource, Int32, CancellationToken).

protected abstract System.Threading.Tasks.ValueTask<System.Threading.RateLimiting.RateLimitLease> AcquireAsyncCore (TResource resource, int permitCount, System.Threading.CancellationToken cancellationToken);
abstract member AcquireAsyncCore : 'Resource * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Threading.RateLimiting.RateLimitLease>
Protected MustOverride Function AcquireAsyncCore (resource As TResource, permitCount As Integer, cancellationToken As CancellationToken) 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.

Applies to