AsyncOperation Classe

Definição

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.EventBasedAsync.dll

Origem:

AsyncOperation.cs

Controla o tempo de vida de uma operação assíncrona.

public ref class AsyncOperation sealed

public sealed class AsyncOperation

type AsyncOperation = class

Public NotInheritable Class AsyncOperation

Herança

Object

AsyncOperation

Exemplos

O exemplo de código a seguir demonstra o uso de um AsyncOperation objeto para acompanhar o tempo de vida de operações assíncronas. Este exemplo de código faz parte de um exemplo maior fornecido para a System.ComponentModel.AsyncOperationManager classe .

Para obter uma listagem de código completa, consulte Como implementar um componente que dá suporte ao padrão assíncrono baseado em evento. Para obter uma listagem de código completa de um formulário de cliente, consulte Como implementar um cliente do padrão assíncrono baseado em evento.

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

Comentários

Ao implementar uma classe de acordo com a Visão geral do padrão assíncrono baseado em evento, talvez seja necessário acompanhar o tempo de vida de cada operação assíncrona invocada em uma instância de sua classe. A AsyncOperation classe fornece maneiras de acompanhar e relatar o progresso de uma tarefa assíncrona.

A lista a seguir identifica maneiras de usar um AsyncOperation objeto:

• Para relatar o progresso e os resultados provisórios para o cliente, chame Post de seu código de trabalho assíncrono.

• Para indicar que uma tarefa assíncrona foi concluída ou cancelar uma tarefa assíncrona pendente, chame PostOperationCompleted.

Sua classe deve obter um AsyncOperation objeto para cada tarefa assíncrona chamando AsyncOperationManager.CreateOperation quando cada tarefa é iniciada. Para permitir que o cliente distingue tarefas assíncronas separadas, AsyncOperationManager.CreateOperation usa um parâmetro para um token exclusivo fornecido pelo cliente, que se torna a UserSuppliedState propriedade . Em seguida, ele pode ser usado pelo código do cliente para identificar a tarefa assíncrona específica que está gerando eventos de progresso ou conclusão.

Notas aos Herdeiros

Os implementadores devem garantir que as PostOperationCompleted(SendOrPostCallback, Object) invocações e Post(SendOrPostCallback, Object) sejam assíncronas, para que os provedores de biblioteca de classes não precisem se preocupar com possíveis estouros de pilha se assumirem um comportamento assíncrono em um modelo de aplicativo específico que por acaso seja síncrono.

Para obter mais informações sobre como implementar classes assíncronas, consulte Implementando o padrão assíncrono baseado em evento.

Propriedades

SynchronizationContext	Obtém o objeto SynchronizationContext que foi transmitido ao construtor.
UserSuppliedState	Obtém ou define um objeto usado para identificar uma operação assíncrona de maneira única.

Métodos

Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
Finalize()	Finaliza a operação assíncrona.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
OperationCompleted()	Encerra o tempo de vida de uma operação assíncrona.
Post(SendOrPostCallback, Object)	Invoca um delegado no thread ou contexto apropriado para o modelo de aplicativo.
PostOperationCompleted(SendOrPostCallback, Object)	Encerra o tempo de vida de uma operação assíncrona.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• AsyncOperationManager
• Práticas recomendadas de threading gerenciado
• Como implementar um componente que dá suporte ao padrão assíncrono baseado em evento