PageAsyncTask クラス

リファレンス

定義

名前空間:: System.Web.UI

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ページに登録されている非同期タスクに関する情報を格納します。このクラスは継承できません。

public ref class PageAsyncTask sealed

public sealed class PageAsyncTask

type PageAsyncTask = class

Public NotInheritable Class PageAsyncTask

継承: Object
PageAsyncTask

例

次のコード例では、3 つの非同期タスクをページに登録し、並列で実行します。各タスクは、単にスレッドが 5 秒間スリープ状態になるだけのメソッドを呼び出します。

<%@ Page Language="C#" Async="true" AsyncTimeout="35"%>

<!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.SlowTask slowTask1 =    
      new Samples.AspNet.CS.Controls.SlowTask();
    Samples.AspNet.CS.Controls.SlowTask slowTask2 =
    new Samples.AspNet.CS.Controls.SlowTask();
    Samples.AspNet.CS.Controls.SlowTask slowTask3 =
    new Samples.AspNet.CS.Controls.SlowTask();
    
    // <Snippet3> 
    PageAsyncTask asyncTask1 = new PageAsyncTask(slowTask1.OnBegin, slowTask1.OnEnd, slowTask1.OnTimeout, "Async1", true);
    PageAsyncTask asyncTask2 = new PageAsyncTask(slowTask2.OnBegin, slowTask2.OnEnd, slowTask2.OnTimeout, "Async2", true);
    PageAsyncTask asyncTask3 = new PageAsyncTask(slowTask3.OnBegin, slowTask3.OnEnd, slowTask3.OnTimeout, "Async3", true);

    // Register the asynchronous task.
    Page.RegisterAsyncTask(asyncTask1);
    Page.RegisterAsyncTask(asyncTask2);
    Page.RegisterAsyncTask(asyncTask3);
    // </Snippet3>
      
    // Execute the register asynchronous task.
    Page.ExecuteRegisteredAsyncTasks();

    TaskMessage.InnerHtml = slowTask1.GetAsyncTaskProgress()+ "<br />" + slowTask2.GetAsyncTaskProgress() + "<br />" + slowTask3.GetAsyncTaskProgress();

  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" 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" %>

<!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 EventArgs)
      
        ' Define the asynchronuous task.
        Dim slowTask1 As New Samples.AspNet.VB.Controls.SlowTask()
        Dim slowTask2 As New Samples.AspNet.VB.Controls.SlowTask()
        Dim slowTask3 As New Samples.AspNet.VB.Controls.SlowTask()
     
        ' <Snippet3>
        Dim asyncTask1 As New PageAsyncTask(AddressOf slowTask1.OnBegin, AddressOf slowTask1.OnEnd, AddressOf slowTask1.OnTimeout, "Async1", True)
        Dim asyncTask2 As New PageAsyncTask(AddressOf slowTask2.OnBegin, AddressOf slowTask2.OnEnd, AddressOf slowTask2.OnTimeout, "Async2", True)
        Dim asyncTask3 As New PageAsyncTask(AddressOf slowTask3.OnBegin, AddressOf slowTask3.OnEnd, AddressOf slowTask3.OnTimeout, "Async3", True)

        ' Register the asynchronous task.
        Page.RegisterAsyncTask(asyncTask1)
        Page.RegisterAsyncTask(asyncTask2)
        Page.RegisterAsyncTask(asyncTask3)
        ' </Snippet3>
      
        ' Execute the register asynchronous task.
        Page.ExecuteRegisteredAsyncTasks()

        TaskMessage.InnerHtml = slowTask1.GetAsyncTaskProgress() + "<br />" + slowTask2.GetAsyncTaskProgress() + "<br />" + slowTask3.GetAsyncTaskProgress()

    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</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 SlowTask
    {
        private String _taskprogress;
        private AsyncTaskDelegate _dlgt;

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

        public String GetAsyncTaskProgress()
        {
            return _taskprogress;
        }
        public void ExecuteAsyncTask()
        {
            // Introduce an artificial delay to simulate a delayed 
            // asynchronous task.
            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 = "AsyncTask started at: " + DateTime.Now + ". ";

            _dlgt = new AsyncTaskDelegate(ExecuteAsyncTask);
            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 += "AsyncTask completed at: " + DateTime.Now;
            _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 += "AsyncTask failed to complete " +
                "because it exceeded the AsyncTimeout parameter.";
        }
    }
}

Imports System.Threading

Namespace Samples.AspNet.VB.Controls

    Public Class SlowTask
        Private _taskprogress As String
        Private _dlgt As AsyncTaskDelegate

        ' Create delegate.
        Protected Delegate Sub AsyncTaskDelegate()

        Public Function GetAsyncTaskProgress() As String
            Return _taskprogress
        End Function

        Public Sub ExecuteAsyncTask()
            ' Introduce an artificial delay to simulate a delayed 
            ' asynchronous task.
            Thread.Sleep(TimeSpan.FromSeconds(5.0))
        End Sub

        ' 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 = "AsyncTask started at: " + DateTime.Now.ToString + ". "

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

            Return result
        End Function

        ' Define the method that will get called when
        ' the asynchronous task is ended.
        Public Sub OnEnd(ByVal ar As IAsyncResult)
            _taskprogress += "AsyncTask completed at: " + DateTime.Now.ToString
            _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 += "AsyncTask failed to complete " + _
                "because it exceeded the AsyncTimeout parameter."
        End Sub
    End Class
End Namespace

注釈

バージョン 2.0 ASP.NET では、ページに複数のタスクを登録し、ページをレンダリングする前に非同期的に実行できます。タスクが低速なプロセスであり、実行中に他のプロセスを関連付けたくない場合は、タスクを非同期的に実行するように指定できます。非同期タスクは、並列または順番に実行できます。

オブジェクトは PageAsyncTask 、メソッドを使用してページに登録する RegisterAsyncTask 必要があります。非同期タスクを実行するために、ページ自体を非同期的に処理する必要はありません。属性trueは Async (次のコード例に示すように) または false page ディレクティブに設定できます。非同期タスクは引き続き非同期的に処理されます。

<%@ Page Async="true" %>

属性が Async に false設定されている場合、ページを実行するスレッドは、すべての非同期タスクが完了するまでブロックされます。

イベントの前に PreRenderComplete 登録された非同期タスクは、まだ実行されていない場合、ページによって自動的に実行されます。イベントの後 PreRenderComplete に登録された非同期タスクは、メソッドを介して ExecuteRegisteredAsyncTasks 明示的に実行する必要があります。メソッドを ExecuteRegisteredAsyncTasks 使用して、イベントの前にタスクを PreRenderComplete 開始することもできます。メソッドは ExecuteRegisteredAsyncTasks 、実行されていないページに登録されているすべての非同期タスクを実行します。

既定では、非同期タスクが 45 秒以内に完了していない場合、タイムアウトします。 Web.config ファイルまたはページディレクティブで、別のタイムアウト値を指定できます。 <pages>Web.config ファイルのセクションには、次に示すように属性がasyncTimeout含まれています。

<system.web>

<pages asyncTimeout="30">

</pages>

</system.web>

page ディレクティブには属性が AsyncTimeout 含まれています。

<%@ Page AsyncTimeout="30" %>

コンストラクター

PageAsyncTask(BeginEventHandler, EndEventHandler, EndEventHandler, Object)	並列実行のために既定値を使用して、PageAsyncTask クラスの新しいインスタンスを初期化します。
PageAsyncTask(BeginEventHandler, EndEventHandler, EndEventHandler, Object, Boolean)	並列実行のために指定した値を使用して、PageAsyncTask クラスの新しいインスタンスを初期化します。
PageAsyncTask(Func<CancellationToken,Task>)	タスクを取り消すことができるようにするイベントハンドラーを使用して、PageAsyncTask クラスの新しいインスタンスを初期化します。
PageAsyncTask(Func<Task>)	タスクを処理できるようにするイベントハンドラーを使用して、PageAsyncTask クラスの新しいインスタンスを初期化します。

プロパティ

BeginHandler	非同期タスクの開始時に呼び出すメソッドを取得します。
EndHandler	タイムアウト期限内にタスクが正常に完了したときに呼び出すメソッドを取得します。
ExecuteInParallel	このタスクを他のタスクと並列で処理できるかどうかを示す値を取得します。
State	タスクの状態を表すオブジェクトを取得します。
TimeoutHandler	タイムアウト期限内にタスクが正常に完了しなかったときに呼び出すメソッドを取得します。

メソッド

Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

適用対象

次の方法で共有

PageAsyncTask クラス

定義

例

注釈

コンストラクター

プロパティ

メソッド

適用対象

その他のリソース