RateLimitLease Class
Definition
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.
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 : IDisposabletype RateLimitLease = class
interface IDisposablePublic MustInherit Class RateLimitLease
Implements IDisposable- Inheritance
-
RateLimitLease
- Implements
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. |