HttpRequest.TimedOutToken Property

Definition

Namespace:

System.Web

Assembly:

System.Web.dll

Gets a CancellationToken object that is tripped when a request times out.

public:
 property System::Threading::CancellationToken TimedOutToken { System::Threading::CancellationToken get(); };

public System.Threading.CancellationToken TimedOutToken { get; }

member this.TimedOutToken : System.Threading.CancellationToken

Public ReadOnly Property TimedOutToken As CancellationToken

Property Value

CancellationToken

The cancellation token.

Remarks

The timeout period can be specified in the Web.config file (see HttpRuntimeSection.ExecutionTimeout) or programmatically (see HttpServerUtility.ScriptTimeout). The timeout period is measured from the time the request comes in. If the default timeout of 110 seconds is in effect, the cancellation token will be tripped no earlier than 110 seconds after request processing begins. You can change the HttpServerUtility.ScriptTimeout property value, and as long this token hasn't tripped yet, the new timeout value will be respected.

Currently the token only provides 15 second granularity, which means that if the timeout value is 110 seconds, the token will be tripped sometime between 110 and 125 seconds after request processing begins. The granularity may change in the future.

Even though this property is thread-safe, there are restrictions on its use. For more information, see HttpResponse.ClientDisconnectedToken.

This property is meaningless if WebSockets request processing has started.