AsyncOperation Class

Definition

Rileva la durata di un'operazione asincrona.Tracks the lifetime of an asynchronous operation.

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

Examples

Nell'esempio di codice riportato di seguito viene illustrato l'utilizzo di un oggetto AsyncOperation per tenere traccia della durata delle operazioni asincrone.The following code example demonstrates using an AsyncOperation object to track the lifetime of asynchronous operations. Questo esempio di codice fa parte di un esempio più ampio fornito per la classe System.ComponentModel.AsyncOperationManager.This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.

Per un listato di codice completo, vedere procedura: implementare un componente che supporta il modello asincrono basato su eventi.For a full code listing, see How to: Implement a Component That Supports the Event-based Asynchronous Pattern. Per un elenco di codice completo di un form client, vedere procedura: implementare un client del modello asincrono basato su eventi.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

Remarks

Quando si implementa una classe in base alla Panoramica del modello asincrono basato su eventi, potrebbe essere necessario tenere traccia della durata di ogni operazione asincrona richiamata in un'istanza della classe.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. La classe AsyncOperation fornisce modi per rilevare e segnalare lo stato di avanzamento di un'attività asincrona.The AsyncOperation class provides ways to track and report the progress of an asynchronous task.

Nell'elenco seguente vengono illustrate le modalità di utilizzo di un oggetto AsyncOperation:The following list identifies ways to use an AsyncOperation object:

  • Per segnalare lo stato di avanzamento e i risultati intermedi al client, chiamare Post dal codice del ruolo di lavoro asincrono.To report progress and interim results to the client, call Post from your asynchronous worker code.

  • Per indicare che un'attività asincrona è stata completata o per annullare un'attività asincrona in sospeso, chiamare PostOperationCompleted.To indicate that an asynchronous task has completed, or to cancel a pending asynchronous task, call PostOperationCompleted.

La classe deve ottenere un oggetto AsyncOperation per ogni attività asincrona chiamando AsyncOperationManager.CreateOperation all'avvio di ogni attività.Your class should get an AsyncOperation object for each asynchronous task by calling AsyncOperationManager.CreateOperation when each task starts. Per consentire al client di distinguere le attività asincrone separate, AsyncOperationManager.CreateOperation accetta un parametro per un token univoco fornito dal client, che diventa la proprietà 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. Può quindi essere usato dal codice client per identificare la particolare attività asincrona che genera eventi di stato o di completamento.It can then be used by client code to identify the particular asynchronous task that is raising progress or completion events.

Notes to Inheritors

Gli implementatori devono garantire che le chiamate di PostOperationCompleted(SendOrPostCallback, Object) e di Post(SendOrPostCallback, Object) siano asincrone, in modo che i provider di librerie di classi non debbano preoccuparsi dei potenziali overflow dello stack se presuppongono un comportamento asincrono in un particolare modello di applicazione che risulta sincrono.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.

Per ulteriori informazioni sull'implementazione di classi asincrone, vedere implementazione del modello asincrono basato su eventi.For more information about implementing asynchronous classes, see Implementing the Event-based Asynchronous Pattern.

Properties

SynchronizationContext

Ottiene l'oggetto SynchronizationContext passato al costruttore.Gets the SynchronizationContext object that was passed to the constructor.

UserSuppliedState

Ottiene o imposta un oggetto usato per identificare in modo univoco un'operazione asincrona.Gets or sets an object used to uniquely identify an asynchronous operation.

Methods

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Finalize()

Finalizza l'operazione asincrona.Finalizes the asynchronous operation.

GetHashCode()

Funge da funzione hash predefinita.Serves as the default hash function.

(Inherited from Object)
GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Inherited from Object)
OperationCompleted()

Pone fine alla durata di un'operazione asincrona.Ends the lifetime of an asynchronous operation.

Post(SendOrPostCallback, Object)

Richiama un delegato nel thread o contesto adeguato al modello di applicazione.Invokes a delegate on the thread or context appropriate for the application model.

PostOperationCompleted(SendOrPostCallback, Object)

Pone fine alla durata di un'operazione asincrona.Ends the lifetime of an asynchronous operation.

ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also