AsyncOperation Classe

Definizione

Rileva la durata di un'operazione asincrona.

public ref class AsyncOperation sealed
public sealed class AsyncOperation
type AsyncOperation = class
Public NotInheritable Class AsyncOperation
Ereditarietà
AsyncOperation

Esempio

Nell'esempio di codice seguente viene illustrato l'uso di un AsyncOperation oggetto per tenere traccia della durata delle operazioni asincrone. Questo esempio di codice fa parte di un esempio più ampio fornito per la System.ComponentModel.AsyncOperationManager classe .

Per un elenco di codice completo, vedere Procedura: Implementare un componente che supporta il modello asincrono basato su eventi. Per un elenco di codice completo di un modulo client, vedere Procedura: Implementare un client del modello asincrono basato su eventi.

// 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

Commenti

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. La AsyncOperation classe consente di tenere traccia e segnalare lo stato di avanzamento di un'attività asincrona.

L'elenco seguente identifica i modi per usare un AsyncOperation oggetto:

  • Per segnalare lo stato di avanzamento e i risultati provvisori al client, chiamare Post dal codice del ruolo di lavoro asincrono.

  • Per indicare che un'attività asincrona è stata completata o per annullare un'attività asincrona in sospeso, chiamare PostOperationCompleted.

La classe deve ottenere un AsyncOperation oggetto per ogni attività asincrona chiamando AsyncOperationManager.CreateOperation all'avvio di ogni attività. Per consentire al client di distinguere attività asincrone separate, AsyncOperationManager.CreateOperation accetta un parametro per un token univoco fornito dal client, che diventa la UserSuppliedState proprietà . Può quindi essere usato dal codice client per identificare l'attività asincrona specifica che genera eventi di avanzamento o completamento.

Note per gli eredi

Gli implementatori devono assicurarsi che le PostOperationCompleted(SendOrPostCallback, Object) chiamate e Post(SendOrPostCallback, Object) siano asincrone, in modo che i provider di librerie di classi non debbano preoccuparsi di potenziali overflow dello stack se presuppongono un comportamento asincrono in un particolare modello di applicazione che si verifica come sincrono.

Per altre informazioni sull'implementazione di classi asincrone, vedere Implementazione del modello asincrono basato su eventi.

Proprietà

SynchronizationContext

Ottiene l'oggetto SynchronizationContext passato al costruttore.

UserSuppliedState

Ottiene o imposta un oggetto usato per identificare in modo univoco un'operazione asincrona.

Metodi

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.

(Ereditato da Object)
Finalize()

Finalizza l'operazione asincrona.

GetHashCode()

Funge da funzione hash predefinita.

(Ereditato da Object)
GetType()

Ottiene l'oggetto Type dell'istanza corrente.

(Ereditato da Object)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.

(Ereditato da Object)
OperationCompleted()

Pone fine alla durata di un'operazione asincrona.

Post(SendOrPostCallback, Object)

Richiama un delegato nel thread o contesto adeguato al modello di applicazione.

PostOperationCompleted(SendOrPostCallback, Object)

Pone fine alla durata di un'operazione asincrona.

ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.

(Ereditato da Object)

Si applica a

Vedi anche