Ho creato una classe thread-safe che lega a CancellationTokenSourcea a Taske garantisce che la CancellationTokenSourcevolontà verrà eliminata al termine della relativa associazione Task. Utilizza i blocchi per garantire che CancellationTokenSourcenon vengano cancellati durante o dopo lo smaltimento. Questo accade per conformità con la documentazione , che afferma:
Il Disposemetodo deve essere utilizzato solo quando tutte le altre operazioni CancellationTokenSourcesull'oggetto sono state completate.
E anche :
Il Disposemetodo lascia lo CancellationTokenSourcestato inutilizzabile.
Ecco la 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;
}
I metodi principali della CancelableExecutionclasse sono il RunAsynce il Cancel. Per impostazione predefinita, le operazioni simultanee non sono consentite, ovvero la chiamataRunAsync una seconda volta annullerà silenziosamente e attenderà il completamento dell'operazione precedente (se è ancora in esecuzione), prima di iniziare la nuova operazione.
Questa classe può essere utilizzata in applicazioni di qualsiasi tipo. Il suo utilizzo principale è tuttavia nelle applicazioni UI, all'interno di moduli con pulsanti per l'avvio e l'annullamento di un'operazione asincrona o con una casella di riepilogo che annulla e riavvia un'operazione ogni volta che viene modificato l'elemento selezionato. Ecco un esempio del primo 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();
}
Il RunAsyncmetodo accetta un extra CancellationTokencome argomento, che è collegato al creato internamente CancellationTokenSource. Fornire questo token opzionale può essere utile in scenari di avanzamento.