RateLimitLease Class

Definition

Namespace:

System.Threading.RateLimiting

Assembly:

System.Threading.RateLimiting.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Abstraction for leases returned by RateLimiter implementations. A lease represents the success or failure to acquire a resource and contains potential metadata that is relevant to the acquisition operation.

public abstract class RateLimitLease : IDisposable

type RateLimitLease = class
    interface IDisposable

Public MustInherit Class RateLimitLease
Implements IDisposable

Inheritance

Object

RateLimitLease

Implements

IDisposable

Constructors

RateLimitLease()

Properties

IsAcquired	Represents whether lease acquisition was successful.
MetadataNames	Gets a list of the metadata names that are available on the lease.

Methods

Dispose()	Dispose the lease. This may free up space on the limiter implementation the lease came from.
Dispose(Boolean)	Dispose method for implementations to write.
GetAllMetadata()	Gets a list of all the metadata that is available on the lease.
TryGetMetadata(String, Object)	Attempt to extract metadata for the lease.
TryGetMetadata<T>(MetadataName<T>, T)	Attempt to extract a strongly-typed metadata for the lease.