RateLimiter.AttemptAcquire(Int32) 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

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.

Fast synchronous attempt to acquire permits.

public System.Threading.RateLimiting.RateLimitLease AttemptAcquire (int permitCount = 1);

member this.AttemptAcquire : int -> System.Threading.RateLimiting.RateLimitLease

Public Function AttemptAcquire (Optional permitCount As Integer = 1) As RateLimitLease

Parameters

permitCount: Int32

Number of permits to try and acquire.

Returns

RateLimitLease

A successful or failed lease.

Exceptions

ArgumentOutOfRangeException

Remarks

Set permitCount to 0 to get whether permits are exhausted.

Applies to