AsyncOperation AsyncOperation AsyncOperation AsyncOperation Class

定義

非同期操作の有効期間を追跡します。Tracks the lifetime of an asynchronous operation.

public ref class AsyncOperation sealed
public sealed class AsyncOperation
type AsyncOperation = class
Public NotInheritable Class AsyncOperation
継承
AsyncOperationAsyncOperationAsyncOperationAsyncOperation

次のコード例に示しますを使用して、AsyncOperation非同期操作の有効期間を追跡するオブジェクト。The following code example demonstrates using an AsyncOperation object to track the lifetime of asynchronous operations. このコード例が示されている例の一部、System.ComponentModel.AsyncOperationManagerクラス。This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.

完全なコード一覧については、次を参照してください。方法。イベントベースの非同期パターンをサポートするコンポーネントを実装する」を参照してください。For a full code listing, see How to: Implement a Component That Supports the Event-based Asynchronous Pattern. クライアントの完全なコード一覧については、次を参照してください。方法。イベントベースの非同期パターンのクライアントを実装する」をご覧ください。For a full code listing of a client form, see How to: Implement a Client of the Event-based Asynchronous Pattern.

// This method starts an asynchronous calculation. 
// First, it checks the supplied task ID for uniqueness.
// If taskId is unique, it creates a new WorkerEventHandler 
// and calls its BeginInvoke method to start the calculation.
public virtual void CalculatePrimeAsync(
    int numberToTest,
    object taskId)
{
    // Create an AsyncOperation for taskId.
    AsyncOperation asyncOp =
        AsyncOperationManager.CreateOperation(taskId);

    // Multiple threads will access the task dictionary,
    // so it must be locked to serialize access.
    lock (userStateToLifetime.SyncRoot)
    {
        if (userStateToLifetime.Contains(taskId))
        {
            throw new ArgumentException(
                "Task ID parameter must be unique", 
                "taskId");
        }

        userStateToLifetime[taskId] = asyncOp;
    }

    // Start the asynchronous operation.
    WorkerEventHandler workerDelegate = new WorkerEventHandler(CalculateWorker);
    workerDelegate.BeginInvoke(
        numberToTest,
        asyncOp,
        null,
        null);
}
' This method starts an asynchronous calculation. 
' First, it checks the supplied task ID for uniqueness.
' If taskId is unique, it creates a new WorkerEventHandler 
' and calls its BeginInvoke method to start the calculation.
Public Overridable Sub CalculatePrimeAsync( _
    ByVal numberToTest As Integer, _
    ByVal taskId As Object)

    ' Create an AsyncOperation for taskId.
    Dim asyncOp As AsyncOperation = _
        AsyncOperationManager.CreateOperation(taskId)

    ' Multiple threads will access the task dictionary,
    ' so it must be locked to serialize access.
    SyncLock userStateToLifetime.SyncRoot
        If userStateToLifetime.Contains(taskId) Then
            Throw New ArgumentException( _
                "Task ID parameter must be unique", _
                "taskId")
        End If

        userStateToLifetime(taskId) = asyncOp
    End SyncLock

    ' Start the asynchronous operation.
    Dim workerDelegate As New WorkerEventHandler( _
        AddressOf CalculateWorker)

    workerDelegate.BeginInvoke( _
        numberToTest, _
        asyncOp, _
        Nothing, _
        Nothing)

End Sub

注釈

に従ってクラスを実装する場合、 - イベント ベースの非同期パターンの概要クラスのインスタンスで呼び出される各非同期操作の有効期間を追跡する必要があります。When you implement a class according to the Event-based Asynchronous Pattern Overview, you may need to track the lifetime of each asynchronous operation invoked on an instance of your class. AsyncOperationクラスには、追跡し、非同期タスクの進行状況を報告する方法が用意されています。The AsyncOperation class provides ways to track and report the progress of an asynchronous task.

次に示しますを使用する方法、AsyncOperationオブジェクト。The following list identifies ways to use an AsyncOperation object:

  • 進行状況と中間結果をクライアントに報告するには、呼び出すPost非同期ワーカー コードから。To report progress and interim results to the client, call Post from your asynchronous worker code.

  • 非同期タスクが完了したことを示すために、または保留中の非同期タスクをキャンセルするには、呼び出すPostOperationCompletedします。To indicate that an asynchronous task has completed, or to cancel a pending asynchronous task, call PostOperationCompleted.

クラスを取得する必要があります、AsyncOperationオブジェクトを呼び出すことによってそれぞれの非同期タスクAsyncOperationManager.CreateOperation各タスクの開始時です。Your class should get an AsyncOperation object for each asynchronous task by calling AsyncOperationManager.CreateOperation when each task starts. 別の非同期タスクを区別するためにクライアントを許可するAsyncOperationManager.CreateOperationをクライアントが提供される一意のトークンがパラメーターを受け取り、UserSuppliedStateプロパティ。To allow the client to distinguish separate asynchronous tasks, AsyncOperationManager.CreateOperation takes a parameter for a unique client-provided token, which becomes the UserSuppliedState property. これは、進行状況や完了イベントを発生させている特定の非同期タスクを識別するためのクライアント コードで使用できます。It can then be used by client code to identify the particular asynchronous task that is raising progress or completion events.

注意 (継承者)

実装のことを確認する必要があります、PostOperationCompleted(SendOrPostCallback, Object)Post(SendOrPostCallback, Object)呼び出しが非同期には、特定のアプリケーションで非同期の動作を前提としている場合に潜在的なスタック オーバーフローが発生できるように、クラス ライブラリのプロバイダーは、使用を意識する必要はありません同期する必要があるモデル。Implementers must ensure the PostOperationCompleted(SendOrPostCallback, Object) and Post(SendOrPostCallback, Object) invocations are asynchronous, so that class library providers do not need to concern themselves with potential stack overflows if they assume asynchronous behavior in a particular application model that happens to be synchronous.

非同期クラスの実装の詳細については、次を参照してください。イベント ベースの非同期パターンを実装するします。For more information about implementing asynchronous classes, see Implementing the Event-based Asynchronous Pattern.

プロパティ

SynchronizationContext SynchronizationContext SynchronizationContext SynchronizationContext

コンストラクターに渡された SynchronizationContext オブジェクトを取得します。Gets the SynchronizationContext object that was passed to the constructor.

UserSuppliedState UserSuppliedState UserSuppliedState UserSuppliedState

非同期操作を一意に識別するために使用するオブジェクトを取得または設定します。Gets or sets an object used to uniquely identify an asynchronous operation.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
Finalize() Finalize() Finalize() Finalize()

非同期操作の終了処理を行います。Finalizes the asynchronous operation.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OperationCompleted() OperationCompleted() OperationCompleted() OperationCompleted()

非同期操作の有効期間を終了します。Ends the lifetime of an asynchronous operation.

Post(SendOrPostCallback, Object) Post(SendOrPostCallback, Object) Post(SendOrPostCallback, Object) Post(SendOrPostCallback, Object)

アプリケーション モデルに適したスレッドまたはコンテキストでデリゲートを呼び出します。Invokes a delegate on the thread or context appropriate for the application model.

PostOperationCompleted(SendOrPostCallback, Object) PostOperationCompleted(SendOrPostCallback, Object) PostOperationCompleted(SendOrPostCallback, Object) PostOperationCompleted(SendOrPostCallback, Object)

非同期操作の有効期間を終了します。Ends the lifetime of an asynchronous operation.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください