Eu criei uma classe thread-safe que vincula a CancellationTokenSource
a Task
e garante que CancellationTokenSource
ele será descartado quando o associado for Task
concluído. Ele usa bloqueios para garantir que o CancellationTokenSource
não seja cancelado durante ou após o descarte. Isso ocorre para conformidade com a documentação , que afirma:
O Dispose
método deve ser usado apenas quando todas as outras operações no CancellationTokenSource
objeto forem concluídas.
E também :
O Dispose
método deixa o CancellationTokenSource
em um estado inutilizável.
Aqui está a classe:
public class CancelableExecution
{
private readonly bool _allowConcurrency;
private Operation _activeOperation;
private class Operation : IDisposable
{
private readonly object _locker = new object();
private readonly CancellationTokenSource _cts;
private readonly TaskCompletionSource<bool> _completionSource;
private bool _disposed;
public Task Completion => _completionSource.Task; // Never fails
public Operation(CancellationTokenSource cts)
{
_cts = cts;
_completionSource = new TaskCompletionSource<bool>(
TaskCreationOptions.RunContinuationsAsynchronously);
}
public void Cancel()
{
lock (_locker) if (!_disposed) _cts.Cancel();
}
void IDisposable.Dispose() // Is called only once
{
try
{
lock (_locker) { _cts.Dispose(); _disposed = true; }
}
finally { _completionSource.SetResult(true); }
}
}
public CancelableExecution(bool allowConcurrency)
{
_allowConcurrency = allowConcurrency;
}
public CancelableExecution() : this(false) { }
public bool IsRunning =>
Interlocked.CompareExchange(ref _activeOperation, null, null) != null;
public async Task<TResult> RunAsync<TResult>(
Func<CancellationToken, Task<TResult>> taskFactory,
CancellationToken extraToken = default)
{
var cts = CancellationTokenSource.CreateLinkedTokenSource(extraToken, default);
using (var operation = new Operation(cts))
{
// Set this as the active operation
var oldOperation = Interlocked.Exchange(ref _activeOperation, operation);
try
{
if (oldOperation != null && !_allowConcurrency)
{
oldOperation.Cancel();
await oldOperation.Completion; // Continue on captured context
}
var task = taskFactory(cts.Token); // Run in the initial context
return await task.ConfigureAwait(false);
}
finally
{
// If this is still the active operation, set it back to null
Interlocked.CompareExchange(ref _activeOperation, null, operation);
}
}
}
public Task RunAsync(Func<CancellationToken, Task> taskFactory,
CancellationToken extraToken = default)
{
return RunAsync<object>(async ct =>
{
await taskFactory(ct).ConfigureAwait(false);
return null;
}, extraToken);
}
public Task CancelAsync()
{
var operation = Interlocked.CompareExchange(ref _activeOperation, null, null);
if (operation == null) return Task.CompletedTask;
operation.Cancel();
return operation.Completion;
}
public bool Cancel() => CancelAsync() != Task.CompletedTask;
}
Os principais métodos da CancelableExecution
classe são the RunAsync
e the Cancel
. Por padrão, operações simultâneas não são permitidas, o que significa que RunAsync
a segunda chamada cancelará silenciosamente e aguardará a conclusão da operação anterior (se ainda estiver em execução), antes de iniciar a nova operação.
Essa classe pode ser usada em aplicativos de qualquer tipo. Seu uso principal, porém, é em aplicativos de interface do usuário, dentro de formulários com botões para iniciar e cancelar uma operação assíncrona ou com uma caixa de listagem que cancela e reinicia uma operação toda vez que seu item selecionado é alterado. Aqui está um exemplo do primeiro caso:
private readonly CancelableExecution _cancelableExecution = new CancelableExecution();
private async void btnExecute_Click(object sender, EventArgs e)
{
string result;
try
{
Cursor = Cursors.WaitCursor;
btnExecute.Enabled = false;
btnCancel.Enabled = true;
result = await _cancelableExecution.RunAsync(async ct =>
{
await Task.Delay(3000, ct); // Simulate some cancelable I/O operation
return "Hello!";
});
}
catch (OperationCanceledException)
{
return;
}
finally
{
btnExecute.Enabled = true;
btnCancel.Enabled = false;
Cursor = Cursors.Default;
}
this.Text += result;
}
private void btnCancel_Click(object sender, EventArgs e)
{
_cancelableExecution.Cancel();
}
O RunAsync
método aceita um extra CancellationToken
como argumento, vinculado ao criado internamente CancellationTokenSource
. O fornecimento desse token opcional pode ser útil em cenários avançados.