Show / Hide Table of Contents

    Class ThrottlingException

    The exception that is thrown when a given request threshold has been reached and then throttled.

    Inheritance
    System.Object
    System.Exception
    HttpStatusCodeException
    ThrottlingException
    Implements
    System.Runtime.Serialization.ISerializable
    Inherited Members
    HttpStatusCodeException.StatusCode
    System.Exception.GetBaseException()
    System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)
    System.Exception.GetType()
    System.Exception.ToString()
    System.Exception.Data
    System.Exception.HelpLink
    System.Exception.HResult
    System.Exception.InnerException
    System.Exception.Message
    System.Exception.Source
    System.Exception.StackTrace
    System.Exception.TargetSite
    System.Exception.SerializeObjectState
    Namespace: Cuemon.AspNetCore.Http.Throttling
    Assembly: Cuemon.AspNetCore.dll
    Syntax
    public class ThrottlingException : HttpStatusCodeException, ISerializable

    Constructors

    | Improve this Doc

    ThrottlingException(Int32, String, Int32, TimeSpan, DateTime)

    Initializes a new instance of the ThrottlingException class.

    Declaration
    public ThrottlingException(int statusCode, string message, int rateLimit, TimeSpan delta, DateTime reset)
    Parameters
    Type Name Description
    System.Int32 statusCode

    The HTTP status code to associate with this exception.

    System.String message

    The message that describes the HTTP status code.

    System.Int32 rateLimit

    The allowed rate of requests for a given window.

    System.TimeSpan delta

    The remaining duration of a window.

    System.DateTime reset

    The date and time when a window is being reset.

    Properties

    | Improve this Doc

    Delta

    Gets the remaining duration of a window.

    Declaration
    public TimeSpan Delta { get; }
    Property Value
    Type Description
    System.TimeSpan

    The remaining duration of a window.

    | Improve this Doc

    RateLimit

    Gets the allowed rate of requests for a given window.

    Declaration
    public int RateLimit { get; }
    Property Value
    Type Description
    System.Int32

    The allowed rate of requests for a given window.

    | Improve this Doc

    Reset

    Gets date and time when a window is being reset.

    Declaration
    public DateTime Reset { get; }
    Property Value
    Type Description
    System.DateTime

    The date and time when a window is being reset.

    Implements

    System.Runtime.Serialization.ISerializable

    Extension Methods

    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, DateTime, Action<TimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, DateTime>, Action<TimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Byte[], Action<ContentBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, Byte[]>, Action<ContentBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, DateTime, Byte[], Action<ContentTimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, DateTime>, Func<T, Byte[]>, Action<ContentTimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, DateTime, Func<T, Byte[]>, Action<ContentTimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, DateTime>, Byte[], Action<ContentTimeBasedOptions>)

    See Also

    HttpStatusCodeException
    • Improve this Doc
    • View Source
    Back to top Copyright 2008-2018 Weubphoria. All rights reserved.
    Generated by DocFX