PartitionedRateLimiter<TResource>.AcquireAsync メソッド

定義

名前空間:

System.Threading.RateLimiting

アセンブリ:

System.Threading.RateLimiting.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

ソース:

PartitionedRateLimiter.T.cs

要求された許可が利用可能か、許可が取得できなくなるまで待ちます。

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)

パラメーター

resource

TResource

制限するリソース。

permitCount

Int32

試行して取得する許可の数。

cancellationToken

CancellationToken

許可のキューに登録された要求を取り消すことを許可する省略可能なトークン。

戻り値

ValueTask<RateLimitLease>

要求された許可が取得されたとき、または要求された許可が拒否されたときに完了するタスク。

例外

ArgumentOutOfRangeException

注釈

許可が補充されるまで待つには、0 に設定 permitCount します。