Stworzyłem klasę bezpieczną dla wątków, która wiąże a CancellationTokenSource
z a Task
i gwarantuje, że CancellationTokenSource
zostanie usunięta, gdy skojarzona z nim zostanie Task
zakończona. Używa blokad, aby zapewnić, że CancellationTokenSource
nie zostaną anulowane podczas lub po ich usunięciu . Dzieje się tak w celu zachowania zgodności z dokumentacją , która stwierdza:
Tej Dispose
metody należy używać tylko wtedy, gdy wszystkie inne operacje na CancellationTokenSource
obiekcie zostały zakończone.
A także :
Dispose
Metoda pozostawia CancellationTokenSource
w stanie nie do użytku.
Oto klasa:
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;
}
Podstawowe metody tej CancelableExecution
klasy to RunAsync
i Cancel
. Domyślnie operacje współbieżne nie są dozwolone, co oznacza, że wywołanie RunAsync
po raz drugi spowoduje ciche anulowanie i oczekiwanie na zakończenie poprzedniej operacji (jeśli nadal jest uruchomiona) przed rozpoczęciem nowej operacji.
Ta klasa może być używana w dowolnych aplikacjach. Jego głównym zastosowaniem jest jednak w aplikacjach UI, wewnątrz formularzy z przyciskami do uruchamiania i anulowania operacji asynchronicznej lub z listą, która anuluje i ponownie uruchamia operację za każdym razem, gdy zostanie zmieniony jej wybrany element. Oto przykład pierwszego przypadku:
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();
}
RunAsync
Sposób przyjmuje dodatkową CancellationToken
jako argumentu, który jest połączony z utworzony wewnętrznie CancellationTokenSource
. Dostarczenie tego opcjonalnego tokena może być przydatne w scenariuszach zaawansowanych.