Show / Hide Table of Contents

    Class TimeMeasuringOptions

    Configuration options for TimeMeasuringFilter.

    Inheritance
    System.Object
    ProfilerOptions
    TimeMeasureOptions
    TimeMeasuringOptions
    Inherited Members
    TimeMeasureOptions.TimeMeasureCompletedThreshold
    TimeMeasureOptions.DefaultTimeMeasureCompletedThreshold
    ProfilerOptions.MethodDescriptor
    ProfilerOptions.RuntimeParameters
    Namespace: Cuemon.AspNetCore.Mvc.Filters.Diagnostics
    Assembly: Cuemon.AspNetCore.Mvc.dll
    Syntax
    public class TimeMeasuringOptions : TimeMeasureOptions

    Constructors

    | Improve this Doc

    TimeMeasuringOptions()

    Initializes a new instance of the TimeMeasuringOptions class.

    Declaration
    public TimeMeasuringOptions()
    Remarks

    The following table shows the initial property values for an instance of TimeMeasureOptions.

    PropertyInitial Value
    TimeMeasureCompletedThresholdSystem.TimeSpan.Zero
    HeaderNameX-Action-Profiler
    SuppressHeaderPredicate_ => false
    UseServerTimingHeadertrue

    Properties

    | Improve this Doc

    HeaderName

    Gets or sets the name of the custom time-measured HTTP header.

    Declaration
    public string HeaderName { get; set; }
    Property Value
    Type Description
    System.String

    The name of the custom time-measured HTTP header.

    | Improve this Doc

    SuppressHeaderPredicate

    Gets or sets the predicate that can suppress either of the time-measured HTTP headers.

    Declaration
    public Func<IHostingEnvironment, bool> SuppressHeaderPredicate { get; set; }
    Property Value
    Type Description
    System.Func<Microsoft.Extensions.Hosting.IHostingEnvironment, System.Boolean>

    The function delegate that can determine if either of the time-measured HTTP headers should be suppressed.

    | Improve this Doc

    UseCustomHeader

    Gets or sets a value indicating whether to include the custom HeaderName specifying how long an action took to execute.

    Declaration
    public bool UseCustomHeader { get; set; }
    Property Value
    Type Description
    System.Boolean

    true to include the custom HeaderName specifying how long an action took to execute; otherwise, false.

    | Improve this Doc

    UseServerTimingHeader

    Gets or sets a value indicating whether to include a Server-Timing HTTP header specifying how long an action took to execute.

    Declaration
    public bool UseServerTimingHeader { get; set; }
    Property Value
    Type Description
    System.Boolean

    true to include a Server-Timing HTTP header specifying how long an action took to execute; otherwise, false.

    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

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