| File: Timeouts\RequestTimeoutAttribute.cs | Web Access |
| Project: src\aspnetcore\src\Http\Http\src\Microsoft.AspNetCore.Http.csproj (Microsoft.AspNetCore.Http) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. namespace Microsoft.AspNetCore.Http.Timeouts; /// <summary> /// Metadata that provides endpoint-specific request timeouts. /// </summary> /// <remarks> /// The default policy will be ignored with this attribute applied. /// </remarks> [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)] public sealed class RequestTimeoutAttribute : Attribute { /// <summary> /// The timeout to apply for this endpoint. /// </summary> public TimeSpan? Timeout { get; } /// <summary> /// The name of the policy which needs to be applied. /// This value is case-insensitive. /// </summary> public string? PolicyName { get; } /// <summary> /// Creates a new instance of <see cref="RequestTimeoutAttribute"/> using the specified timeout. /// </summary> /// <param name="milliseconds">The duration, in milliseconds, of the timeout for this endpoint.</param> public RequestTimeoutAttribute(int milliseconds) { Timeout = TimeSpan.FromMilliseconds(milliseconds); } /// <summary> /// Creates a new instance of <see cref="RequestTimeoutAttribute"/> using the specified policy. /// </summary> /// <param name="policyName">The name of the policy which needs to be applied (case-insensitive).</param> public RequestTimeoutAttribute(string policyName) { PolicyName = policyName; } }