AsyncOperation AsyncOperation AsyncOperation AsyncOperation Class

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
AsyncOperationAsyncOperationAsyncOperationAsyncOperation

Beispiele

Das folgende Codebeispiel veranschaulicht die Verwendung einer AsyncOperation Objekt, das die Lebensdauer der asynchronen Vorgänge zu verfolgen.The following code example demonstrates using an AsyncOperation object to track the lifetime of asynchronous operations. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels für die System.ComponentModel.AsyncOperationManager Klasse.This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.

Eine vollständige codeauflistung finden Sie unter Vorgehensweise: Ü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 codeauflistung eines Client-Formulars, finden Sie unter Vorgehensweise: 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

Bei der Implementierung einer Klasse gemäß den Übersicht über ereignisbasierte asynchrone Muster, müssen Sie möglicherweise die Lebensdauer der einzelnen asynchronen Vorgänge, die in einer Instanz Ihrer Klasse aufgerufen nachzuverfolgen.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 bietet Methoden zum Nachverfolgen und melden den Fortschritt einer asynchronen Aufgabe.The AsyncOperation class provides ways to track and report the progress of an asynchronous task.

Die folgende Liste enthält Möglichkeiten zur Verwendung einer AsyncOperation Objekt:The following list identifies ways to use an AsyncOperation object:

  • Aufrufen, um Fortschritt und die vorläufigen Ergebnisse an den Client zu melden, Post aus Ihrem asynchronen Code.To report progress and interim results to the client, call Post from your asynchronous worker code.

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

Die Klasse sollte angezeigt werden. ein AsyncOperation Objekt für jeden asynchronen Vorgang durch Aufrufen von AsyncOperationManager.CreateOperation zu Beginn jeder Aufgabe.Your class should get an AsyncOperation object for each asynchronous task by calling AsyncOperationManager.CreateOperation when each task starts. Damit der Client unterschiedliche asynchrone Aufgaben, unterscheiden kann AsyncOperationManager.CreateOperation nimmt einen Parameter für ein eindeutiges vom Client bereitgestellte Token, wird die UserSuppliedState Eigenschaft.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. Dann kann von Clientcode verwendet werden, um die asynchrone Aufgabe zu identifizieren, die Verarbeitung oder Ihren Abschluss Ereignisse ausgelöst wird.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

Implementierungen müssen die PostOperationCompleted(SendOrPostCallback, Object) und Post(SendOrPostCallback, Object) asynchron aufgerufen werden, sodass Klasse Bibliothek Anbieter nicht müssen sich darum kümmern, potenzielle Stapelüberlauf auftritt, wenn sie asynchrone Verhalten einer bestimmten Anwendung ausgehen Modell, die zufällig synchron sein.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 zu asynchrone Klassen implementieren, finden Sie unter Implementieren des ereignisbasierten asynchronen Entwurfsmusters.For more information about implementing asynchronous classes, see Implementing the Event-based Asynchronous Pattern.

Eigenschaften

SynchronizationContext SynchronizationContext SynchronizationContext SynchronizationContext

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

UserSuppliedState UserSuppliedState UserSuppliedState 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) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

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

Beendet den asynchronen Vorgang.Finalizes the asynchronous operation.

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

Fungiert als Standardhashfunktion.Serves as the default hash function.

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

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

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

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

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

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

Post(SendOrPostCallback, Object) Post(SendOrPostCallback, Object) Post(SendOrPostCallback, Object) 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) PostOperationCompleted(SendOrPostCallback, Object) PostOperationCompleted(SendOrPostCallback, Object) PostOperationCompleted(SendOrPostCallback, Object)

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

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

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

(Inherited from Object)

Gilt für:

Siehe auch