Page.AsyncTimeout Eigenschaft

  • Referenz

Definition

Namespace:
System.Web.UI
Assembly:
System.Web.dll

Ruft einen Wert ab, der das Timeoutintervall für das Verarbeiten asynchroner Aufgaben angibt, oder legt diesen fest.

public:
 property TimeSpan AsyncTimeout { TimeSpan get(); void set(TimeSpan value); };
[System.ComponentModel.Browsable(false)]
public TimeSpan AsyncTimeout { get; set; }
[<System.ComponentModel.Browsable(false)>]
member this.AsyncTimeout : TimeSpan with get, set
Public Property AsyncTimeout As TimeSpan

Eigenschaftswert

TimeSpan

Eine TimeSpan, die das zulässige Zeitintervall für den Abschluss der asynchronen Aufgabe enthält. Das Standardzeitintervall beträgt 45 Sekunden.

Attribute
BrowsableAttribute

Ausnahmen

ArgumentException

Die Eigenschaft wurde auf einen negativen Wert festgelegt.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der AsyncTimeout -Eigenschaft mit den ExecuteRegisteredAsyncTasks Methoden und RegisterAsyncTask veranschaulicht. Beachten Sie die Verwendung von Anfangs-, End- und Timeouthandlern. Im Beispiel wird eine künstliche Verzögerung eingeführt, um die Situation eines asynchronen Vorgangs zu veranschaulichen, der die in der AsyncTimeout -Eigenschaft angegebene Zeit für den Vorgang überschreitet. In einem realen Szenario kann eine asynchrone Aufgabe beispielsweise zum Ausführen von Datenbankaufrufen oder zur Bildgenerierung verwendet werden, und der Timeouthandler sorgt für eine ordnungsgemäße Beeinträchtigung, wenn die Aufgabe nicht in einem bestimmten Zeitraum ausgeführt wird. Beachten Sie, dass die AsyncTimeout -Eigenschaft in der Seitendirektive festgelegt ist.

<%@ Page Language="C#" AsyncTimeout="2"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  protected void Page_Load(object sender, EventArgs e)
  {
    // Define the asynchronuous task.
    Samples.AspNet.CS.Controls.MyAsyncTask mytask =    
      new Samples.AspNet.CS.Controls.MyAsyncTask();
    PageAsyncTask asynctask = new PageAsyncTask(mytask.OnBegin, mytask.OnEnd, mytask.OnTimeout, null);

    // Register the asynchronous task.
    Page.RegisterAsyncTask(asynctask);
      
    // Execute the register asynchronous task.
    Page.ExecuteRegisteredAsyncTasks();

    TaskMessage.InnerHtml = mytask.GetAsyncTaskProgress();

  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Asynchronous Task Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <span id="TaskMessage" runat="server">
      </span>
    </div>
    </form>
</body>
</html>

<%@ Page Language="VB" AsyncTimeout="2"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
    
    ' Define the asynchronuous task.
    Dim mytask As New Samples.AspNet.VB.Controls.MyAsyncTask()
    Dim asynctask As New PageAsyncTask(AddressOf mytask.OnBegin, AddressOf mytask.OnEnd, AddressOf mytask.OnTimeout, DBNull.Value)

    ' Register the asynchronous task.
    Page.RegisterAsyncTask(asynctask)
      
    ' Execute the register asynchronous task.
    Page.ExecuteRegisteredAsyncTasks()

    TaskMessage.InnerHtml = mytask.GetAsyncTaskProgress()
    
  End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Asynchronous Task Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <span id="TaskMessage" runat="server">
      </span>
    </div>
    </form>
</body>
</html>

using System;
using System.Web;
using System.Web.UI;
using System.Threading;

namespace Samples.AspNet.CS.Controls
{
    public class MyAsyncTask
    {
        private String _taskprogress;
        private AsyncTaskDelegate _dlgt;

        // Create delegate.
        protected delegate void AsyncTaskDelegate();

        public String GetAsyncTaskProgress()
        {
            return _taskprogress;
        }
        public void DoTheAsyncTask()
        {
            // Introduce an artificial delay to simulate a delayed 
            // asynchronous task. Make this greater than the 
            // AsyncTimeout property.
            Thread.Sleep(TimeSpan.FromSeconds(5.0));
        }

        // Define the method that will get called to
        // start the asynchronous task.
        public IAsyncResult OnBegin(object sender, EventArgs e,
            AsyncCallback cb, object extraData)
        {
            _taskprogress = "Beginning async task.";

            _dlgt = new AsyncTaskDelegate(DoTheAsyncTask);
            IAsyncResult result = _dlgt.BeginInvoke(cb, extraData);

                        return result;
        }

        // Define the method that will get called when
        // the asynchronous task is ended.
        public void OnEnd(IAsyncResult ar)
        {
            _taskprogress = "Asynchronous task completed.";
            _dlgt.EndInvoke(ar);
        }

        // Define the method that will get called if the task
        // is not completed within the asynchronous timeout interval.
        public void OnTimeout(IAsyncResult ar)
        {
            _taskprogress = "Ansynchronous task failed to complete " +
                "because it exceeded the AsyncTimeout parameter.";
        }
    }
}

Imports System.Web
Imports System.Web.UI
Imports System.Threading

Namespace Samples.AspNet.VB.Controls

    Public Class MyAsyncTask

        Private _taskprogress As String
        Private _dlgt As AsyncTaskDelegate

        ' Create delegate.
        Delegate Function AsyncTaskDelegate()

        Public Function GetAsyncTaskProgress() As String
            Return _taskprogress
        End Function

        Public Function DoTheAsyncTask()

            ' Introduce an artificial delay to simulate a delayed 
            ' asynchronous task. Make this greater than the 
            ' AsyncTimeout property.
            Thread.Sleep(TimeSpan.FromSeconds(5.0))

        End Function


        ' Define the method that will get called to
        ' start the asynchronous task.
        Public Function OnBegin(ByVal sender As Object, ByVal e As EventArgs, ByVal cb As AsyncCallback, ByVal extraData As Object) As IAsyncResult

            _taskprogress = "Beginning async task."

            Dim _dlgt As New AsyncTaskDelegate(AddressOf DoTheAsyncTask)
            Dim result As IAsyncResult = _dlgt.BeginInvoke(cb, extraData)
            Return result

        End Function 'OnBegin

        ' Define the method that will get called when
        ' the asynchronous task is ended.
        Public Sub OnEnd(ByVal ar As IAsyncResult)

            _taskprogress = "Asynchronous task completed."
            _dlgt.EndInvoke(ar)

        End Sub

        ' Define the method that will get called if the task
        ' is not completed within the asynchronous timeout interval.
        Public Sub OnTimeout(ByVal ar As IAsyncResult)

            _taskprogress = "Ansynchronous task failed to complete because " & _
            "it exceeded the AsyncTimeout parameter."

        End Sub

    End Class

End Namespace

Hinweise

Das asynchrone Timeout der Seite stellt die Zeit dar, in der die Seite auf asynchrone Aufgaben wartet. Legen Sie diese Eigenschaft in den meisten Fällen nicht im Code fest. Legen Sie das seitenasynchrone Timeoutintervall mithilfe des pages-Elements der Webkonfigurationsdatei oder in der @ Page-Direktive fest. Werte, die im Seitenkonfigurationsabschnitt festgelegt sind, werden von der Seitendirektive überschrieben.

Definieren Sie Ihre asynchrone Aufgabe mithilfe der PageAsyncTask -Klasse, und registrieren Sie einen Anfang, einen End- und einen Timeouthandler. Wenn die asynchrone Aufgabe nicht im angegebenen Zeitintervall abgeschlossen wird, wird der Timeouthandler aufgerufen.

Gilt für:

Weitere Informationen