Cancelamento de tarefas
As System.Threading.Tasks.Task classes e System.Threading.Tasks.Task<TResult> suportam o cancelamento usando tokens de cancelamento. Para obter mais informações, consulte Cancelamento em threads gerenciados. Nas classes Task, o cancelamento envolve a cooperação entre o delegado do usuário, que representa uma operação cancelável, e o código que solicitou o cancelamento. Um cancelamento bem-sucedido envolve o código solicitante chamando o CancellationTokenSource.Cancel método e o usuário delegando encerrando a operação em tempo hábil. Você pode encerrar a operação usando uma destas opções:
Voltando do delegado. Em muitos cenários, esta opção é suficiente. No entanto, uma instância de tarefa cancelada dessa forma transita para o TaskStatus.RanToCompletion estado, não para o TaskStatus.Canceled estado.
Jogando um OperationCanceledException e passando-lhe o token no qual o cancelamento foi solicitado. A maneira preferida de executar é usar o ThrowIfCancellationRequested método. Uma tarefa cancelada dessa forma transita para o estado Cancelado, que o código de chamada pode usar para verificar se a tarefa respondeu à sua solicitação de cancelamento.
O exemplo a seguir mostra o padrão básico para cancelamento de tarefas que gera a exceção:
Nota
O token é passado para o delegado do usuário e para a instância da tarefa.
using System;
using System.Threading;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
var tokenSource2 = new CancellationTokenSource();
CancellationToken ct = tokenSource2.Token;
var task = Task.Run(() =>
{
// Were we already canceled?
ct.ThrowIfCancellationRequested();
bool moreToDo = true;
while (moreToDo)
{
// Poll on this property if you have to do
// other cleanup before throwing.
if (ct.IsCancellationRequested)
{
// Clean up here, then...
ct.ThrowIfCancellationRequested();
}
}
}, tokenSource2.Token); // Pass same token to Task.Run.
tokenSource2.Cancel();
// Just continue on this thread, or await with try-catch:
try
{
await task;
}
catch (OperationCanceledException e)
{
Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
}
finally
{
tokenSource2.Dispose();
}
Console.ReadKey();
}
}
Imports System.Threading
Imports System.Threading.Tasks
Module Test
Sub Main()
Dim tokenSource2 As New CancellationTokenSource()
Dim ct As CancellationToken = tokenSource2.Token
Dim t2 = Task.Factory.StartNew(Sub()
' Were we already canceled?
ct.ThrowIfCancellationRequested()
Dim moreToDo As Boolean = True
While moreToDo = True
' Poll on this property if you have to do
' other cleanup before throwing.
If ct.IsCancellationRequested Then
' Clean up here, then...
ct.ThrowIfCancellationRequested()
End If
End While
End Sub _
, tokenSource2.Token) ' Pass same token to StartNew.
' Cancel the task.
tokenSource2.Cancel()
' Just continue on this thread, or Wait/WaitAll with try-catch:
Try
t2.Wait()
Catch e As AggregateException
For Each item In e.InnerExceptions
Console.WriteLine(e.Message & " " & item.Message)
Next
Finally
tokenSource2.Dispose()
End Try
Console.ReadKey()
End Sub
End Module
Para obter um exemplo completo, consulte Como cancelar uma tarefa e seus filhos.
Quando uma instância de tarefa observa um OperationCanceledException código lançado pelo usuário, ela compara o token da exceção com seu token associado (aquele que foi passado para a API que criou a tarefa). Se os tokens forem iguais e a propriedade do IsCancellationRequested token retornar true, a tarefa interpretará isso como reconhecimento de cancelamento e transições para o estado Cancelado. Se você não usar um Wait método ou WaitAll para aguardar a tarefa, a tarefa apenas definirá seu status como Canceled.
Se você estiver aguardando uma Tarefa que transita para o estado Cancelado, uma System.Threading.Tasks.TaskCanceledException exceção (encapsulada em uma AggregateException exceção) será lançada. Esta exceção indica cancelamento bem-sucedido em vez de uma situação defeituosa. Portanto, a propriedade da Exception tarefa retorna null.
Se a propriedade do IsCancellationRequested token retornar false ou se o token da exceção não corresponder ao token da Tarefa, o OperationCanceledException será tratado como uma exceção normal, fazendo com que a Tarefa faça a transição para o estado Faulted. A presença de outras exceções também fará com que a Tarefa faça a transição para o estado Falhado. Você pode obter o status da tarefa concluída na Status propriedade.
É possível que uma tarefa continue a processar alguns itens após o cancelamento ser solicitado.
