Page.AsyncTimeout Property


This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a value indicating the time-out interval used when processing asynchronous tasks.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

member AsyncTimeout : TimeSpan with get, set

Property Value

Type: System.TimeSpan

A TimeSpan that contains the allowed time interval for completion of the asynchronous task. The default time interval is 45 seconds.

Exception Condition

The property was set to a negative value.

The asynchronous time-out of the page represents the amount of time that the page will wait to perform asynchronous tasks. In most circumstances, do not set this property in code. Set the page asynchronous time-out interval using the of the Web configuration file or in the directive. Values set in the page configuration section are overwritten by the page directive.

Define your asynchronous task using the PageAsyncTask class and register a beginning, an ending, and a time-out handler. If the asynchronous task does not complete in the time interval specified, the time-out handler will be invoked.

The following code example demonstrates the use of the AsyncTimeout property with the ExecuteRegisteredAsyncTasks and RegisterAsyncTask methods. Note the use of beginning, ending, and time-out handlers. In the example, an artificial delay is introduced to demonstrate the situation of an asynchronous task exceeding the allotted time for the task as specified in the AsyncTimeout property. In a real-world scenario, an asynchronous task could be used to perform database calls or image generation, for example, and the time-out handler provides graceful degradation if the task is not performed in a specified amount of time. Note that the AsyncTimeout property is set in the page directive.

No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top