Struct ThrottlingEventArgs

Namespace

RateLimitHeaders.Events

Assembly

RateLimitHeaders.dll

Provides data for throttling events from the HTTP handler.

[SuppressMessage("Naming", "CA1711:Identifiers should not have incorrect suffix", Justification = "EventArgs suffix is intentional for event data records")]
public readonly record struct ThrottlingEventArgs : IEquatable<ThrottlingEventArgs>

Implements

IEquatable<ThrottlingEventArgs>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ThrottlingEventArgs(RateLimitInfo, Uri?, TimeSpan, string?)

Provides data for throttling events from the HTTP handler.

public ThrottlingEventArgs(RateLimitInfo RateLimitInfo, Uri? RequestUri, TimeSpan Delay, string? Reason)

Parameters

RateLimitInfo RateLimitInfo

The parsed rate limit information.

RequestUri Uri

The URI of the request being throttled.

Delay TimeSpan

The delay being applied.

Reason string

The reason for throttling.

Properties

Delay

The delay being applied.

public TimeSpan Delay { get; init; }

Property Value

TimeSpan

RateLimitInfo

The parsed rate limit information.

public RateLimitInfo RateLimitInfo { get; init; }

Property Value

RateLimitInfo

Reason

The reason for throttling.

public string? Reason { get; init; }

Property Value

string

RequestUri

The URI of the request being throttled.

public Uri? RequestUri { get; init; }

Property Value

Uri