AsyncOperation Klasse

Definition

Verfolgt die Lebensdauer eines asynchronen Vorgangs.Tracks the lifetime of an asynchronous operation.

public ref class AsyncOperation sealed
public sealed class AsyncOperation
type AsyncOperation = class
Public NotInheritable Class AsyncOperation
Vererbung
AsyncOperation

Beispiele

Im folgenden Codebeispiel wird die Verwendung AsyncOperation eines-Objekts zum Nachverfolgen der Lebensdauer von asynchronen Vorgängen veranschaulicht.The following code example demonstrates using an AsyncOperation object to track the lifetime of asynchronous operations. Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die System.ComponentModel.AsyncOperationManager -Klasse bereitgestellt wird.This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.

Eine vollständige Code Auflistung finden Sie unter Gewusst wie: Übersicht über ereignisbasierte asynchrone Muster.For a full code listing, see How to: Implement a Component That Supports the Event-based Asynchronous Pattern. Eine vollständige Code Auflistung eines Client Formulars finden Sie unter Gewusst wie: Implementieren eines Clients des ereignisbasierten asynchronen Musters.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

Hinweise

Wenn Sie eine Klasse gemäß der Übersicht über das ereignisbasierte asynchrone Musterimplementieren, müssen Sie möglicherweise die Lebensdauer der einzelnen asynchronen Vorgänge, die für eine Instanz der Klasse aufgerufen werden, nachverfolgen.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. Die AsyncOperation -Klasse stellt Methoden bereit, um den Fortschritt einer asynchronen Aufgabe zu verfolgen und zu melden.The AsyncOperation class provides ways to track and report the progress of an asynchronous task.

In der folgenden Liste sind die Verwendungsmöglichkeiten AsyncOperation eines Objekts aufgeführt:The following list identifies ways to use an AsyncOperation object:

  • Um Status-und Zwischenergebnisse an den Client zu melden Post , wenden Sie sich an den asynchronen Workercode.To report progress and interim results to the client, call Post from your asynchronous worker code.

  • Um anzugeben, dass eine asynchrone Aufgabe abgeschlossen wurde, oder um eine ausstehende asynchrone Aufgabe abzubrechen PostOperationCompleted, rufen Sie auf.To indicate that an asynchronous task has completed, or to cancel a pending asynchronous task, call PostOperationCompleted.

Die Klasse sollte ein AsyncOperation Objekt für jede asynchrone Aufgabe abrufen, indem aufgerufen AsyncOperationManager.CreateOperation wird, wenn die einzelnen Aufgaben gestartet werden.Your class should get an AsyncOperation object for each asynchronous task by calling AsyncOperationManager.CreateOperation when each task starts. Um dem Client die Unterscheidung einzelner asynchroner Aufgaben zu AsyncOperationManager.CreateOperation ermöglichen, nimmt einen Parameter für ein eindeutiges vom UserSuppliedState Client bereitgestelltes Token an, das zur-Eigenschaft wird.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. Sie kann dann vom Client Code verwendet werden, um die asynchrone Aufgabe zu identifizieren, die Status-oder Beendigungs Ereignisse aufhebt.It can then be used by client code to identify the particular asynchronous task that is raising progress or completion events.

Hinweise für Vererber

Implementierer müssen sicher PostOperationCompleted(SendOrPostCallback, Object) stellen Post(SendOrPostCallback, Object) , dass die Aufrufe und asynchron ausgeführt werden, damit Klassen Bibliotheks Anbieter sich nicht auf potenzielle Stapel Überläufe beziehen müssen, wenn Sie ein asynchrones Verhalten in einer bestimmten Anwendung annehmen. das Modell, das synchron ist.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.

Weitere Informationen zum Implementieren von asynchronen Klassen finden Sie unter Implementieren des ereignisbasierten asynchronen Musters.For more information about implementing asynchronous classes, see Implementing the Event-based Asynchronous Pattern.

Eigenschaften

SynchronizationContext

Ruft das SynchronizationContext-Objekt ab, das an den Konstruktor übergeben wurde.Gets the SynchronizationContext object that was passed to the constructor.

UserSuppliedState

Ruft ein Objekt ab, das für die eindeutige Identifikation eines asynchronen Vorgangs verwendet wird, und legt dieses fest.Gets or sets an object used to uniquely identify an asynchronous operation.

Methoden

Equals(Object)

Ermittelt, ob das angegebene Objekt und das aktuelle Objekt gleich sind.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
Finalize()

Beendet den asynchronen Vorgang.Finalizes the asynchronous operation.

GetHashCode()

Dient als die Standard-HashfunktionServes as the default hash function.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
OperationCompleted()

Beendet die Lebensdauer eines asynchronen Vorgangs.Ends the lifetime of an asynchronous operation.

Post(SendOrPostCallback, Object)

Ruft einen Delegaten auf dem Thread oder Kontext auf, der für das Anwendungsmodell geeignet ist.Invokes a delegate on the thread or context appropriate for the application model.

PostOperationCompleted(SendOrPostCallback, Object)

Beendet die Lebensdauer eines asynchronen Vorgangs.Ends the lifetime of an asynchronous operation.

ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Gilt für:

Siehe auch