Registrar retornos de chamada para solicitações de cancelamento
Saiba como registrar um representante que será invocado quando uma IsCancellationRequested propriedade se tornar verdadeira. O valor muda de false para true quando uma chamada para Cancel no objeto que criou o token é feita. Use essa técnica para cancelar operações assíncronas que não oferecem suporte nativo à estrutura de cancelamento unificada e para desbloquear métodos que possam estar aguardando a conclusão de uma operação assíncrona.
Nota
Quando "Just My Code" está habilitado, o Visual Studio em alguns casos quebrará na linha que lança a exceção e exibirá uma mensagem de erro que diz "exceção não tratada pelo código do usuário". Este erro é benigno. Você pode pressionar F5 para continuar a partir dele e ver o comportamento de manipulação de exceções demonstrado nos exemplos abaixo. Para evitar que o Visual Studio quebre no primeiro erro, basta desmarcar a caixa de seleção "Apenas meu código" em Ferramentas, Opções, Depuração, Geral.
Exemplo
No exemplo a seguir, o CancelAsync método é registrado como o método a ser invocado quando o cancelamento é solicitado por meio do token de cancelamento.
using System;
using System.Net;
using System.Threading;
using System.Threading.Tasks;
class CancelWithCallback
{
static void Main()
{
using var cts = new CancellationTokenSource();
var token = cts.Token;
_ = Task.Run(async () =>
{
using var client = new WebClient();
client.DownloadStringCompleted += (_, args) =>
{
if (args.Cancelled)
{
Console.WriteLine("The download was canceled.");
}
else
{
Console.WriteLine("The download has completed:\n");
Console.WriteLine($"{args.Result}\n\nPress any key to continue.");
}
};
if (!token.IsCancellationRequested)
{
using CancellationTokenRegistration ctr = token.Register(() => client.CancelAsync());
Console.WriteLine("Starting request\n");
await client.DownloadStringTaskAsync(new Uri("http://www.contoso.com"));
}
}, token);
Console.WriteLine("Press 'c' to cancel.\n\n");
if (Console.ReadKey().KeyChar == 'c')
{
cts.Cancel();
}
Console.WriteLine("\nPress any key to exit.");
Console.ReadKey();
}
}
Imports System.Net
Imports System.Threading
Friend Class CancelWithCallback
Private Shared Sub Main()
Using cts = New CancellationTokenSource()
Dim token = cts.Token
Task.Run(
Async Function()
Using client As New WebClient()
AddHandler client.DownloadDataCompleted,
Sub(__, args)
If args.Cancelled Then
Console.WriteLine("The download was canceled.")
Else
Console.WriteLine($"The download has completed:{vbLf}")
Console.WriteLine($"{args.Result}{vbLf}{vbLf}Press any key to continue.")
End If
End Sub
If Not token.IsCancellationRequested Then
Dim ctr As CancellationTokenRegistration = token.Register(Sub() client.CancelAsync())
Console.WriteLine($"Starting request{vbLf}")
Await client.DownloadStringTaskAsync(New Uri("http://www.contoso.com"))
End If
End Using
End Function, token)
Console.WriteLine($"Press 'c' to cancel.{vbLf}{vbLf}")
If Console.ReadKey().KeyChar = "c"c Then
cts.Cancel()
End If
Console.WriteLine($"{vbLf}Press any key to exit.")
Console.ReadKey()
End Using
End Sub
End Class
Se o cancelamento já tiver sido solicitado quando o retorno de chamada for registrado, o retorno de chamada ainda é garantido para ser chamado. Neste caso em particular, o CancelAsync método não fará nada se nenhuma operação assíncrona estiver em andamento, portanto, é sempre seguro chamar o método.
