AsyncOperation AsyncOperation AsyncOperation AsyncOperation Class

Definição

Controla o tempo de vida de uma operação assíncrona.Tracks the lifetime of an asynchronous operation.

public ref class AsyncOperation sealed
public sealed class AsyncOperation
type AsyncOperation = class
Public NotInheritable Class AsyncOperation
Herança
AsyncOperationAsyncOperationAsyncOperationAsyncOperation

Exemplos

O exemplo de código a seguir demonstra como usar um AsyncOperation objeto para controlar o tempo de vida de operações assíncronas.The following code example demonstrates using an AsyncOperation object to track the lifetime of asynchronous operations. Este exemplo de código é parte de um exemplo maior fornecido para o System.ComponentModel.AsyncOperationManager classe.This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.

Para obter uma listagem de código completo, consulte como: implementar um componente compatível com o padrão assíncrono baseado em evento.For a full code listing, see How to: Implement a Component That Supports the Event-based Asynchronous Pattern. Para obter uma listagem de código completo de um formulário cliente, consulte como: Implementar um cliente do padrão assíncrono baseado em evento.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

Comentários

Quando você implementa uma classe de acordo com o Event-based Asynchronous Pattern Overview, talvez você precise controlar o tempo de vida de cada operação assíncrona invocada em uma instância de sua 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. O AsyncOperation classe fornece maneiras de rastrear e relatar o progresso de uma tarefa assíncrona.The AsyncOperation class provides ways to track and report the progress of an asynchronous task.

A seguinte lista identifica maneiras de usar um AsyncOperation objeto:The following list identifies ways to use an AsyncOperation object:

  • Para relatar o progresso e os resultados intermediários ao cliente, chamar Post do seu código de trabalho assíncrono.To report progress and interim results to the client, call Post from your asynchronous worker code.

  • Para indicar que uma tarefa assíncrona foi concluída, ou para cancelar uma tarefa assíncrona pendente, chame PostOperationCompleted.To indicate that an asynchronous task has completed, or to cancel a pending asynchronous task, call PostOperationCompleted.

Sua classe deve obter um AsyncOperation objeto para cada tarefa assíncrona chamando AsyncOperationManager.CreateOperation quando cada tarefa é iniciado.Your class should get an AsyncOperation object for each asynchronous task by calling AsyncOperationManager.CreateOperation when each task starts. Para permitir ao cliente distinguir separadas tarefas assíncronas, AsyncOperationManager.CreateOperation leva um parâmetro para um exclusivo token fornecido pelo cliente, que se torna o UserSuppliedState propriedade.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. Ele pode então ser usado pelo código do cliente para identificar a tarefa assíncrona específica que está gerando eventos de progresso ou a conclusão.It can then be used by client code to identify the particular asynchronous task that is raising progress or completion events.

Notas aos Herdeiros

Os implementadores devem garantir que o PostOperationCompleted(SendOrPostCallback, Object) e Post(SendOrPostCallback, Object) chamadas são assíncronas, para que os provedores de biblioteca de classe não é preciso preocupar-se com o potencial estouro de pilha, se ele assume o comportamento assíncrono em um aplicativo específico modelo que seja síncrona.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.

Para obter mais informações sobre como implementar classes assíncronas, consulte Implementando o padrão assíncrono baseado em evento.For more information about implementing asynchronous classes, see Implementing the Event-based Asynchronous Pattern.

Propriedades

SynchronizationContext SynchronizationContext SynchronizationContext SynchronizationContext

Obtém o objeto SynchronizationContext que foi transmitido ao construtor.Gets the SynchronizationContext object that was passed to the constructor.

UserSuppliedState UserSuppliedState UserSuppliedState UserSuppliedState

Obtém ou define um objeto usado para identificar uma operação assíncrona de maneira única.Gets or sets an object used to uniquely identify an asynchronous operation.

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

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

Finaliza a operação assíncrona.Finalizes the asynchronous operation.

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

Serve como a função de hash padrão.Serves as the default hash function.

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

Obtém o Type da instância atual.Gets the Type of the current instance.

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

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

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

Encerra o tempo de vida de uma operação assíncrona.Ends the lifetime of an asynchronous operation.

Post(SendOrPostCallback, Object) Post(SendOrPostCallback, Object) Post(SendOrPostCallback, Object) Post(SendOrPostCallback, Object)

Invoca um delegado no thread ou contexto apropriado para o modelo de aplicativo.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)

Encerra o tempo de vida de uma operação assíncrona.Ends the lifetime of an asynchronous operation.

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

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Inherited from Object)

Aplica-se a

Veja também