Procedura: mettersi in ascolto di richieste di annullamento tramite polling
Nell'esempio seguente viene illustrato un modo in cui il codice utente può eseguire il polling di un token di annullamento a intervalli regolari per verificare se l'annullamento è stato richiesto dal thread chiamante. In questo esempio viene utilizzato il tipo System.Threading.Tasks.Task, ma lo stesso modello è valido per le operazioni asincrone create direttamente dal tipo System.Threading.ThreadPool o dal tipo System.Threading.Thread.
Esempio
Il polling richiede un tipo di codice di ciclo o ricorsivo in grado di leggere periodicamente il valore della proprietà IsCancellationRequested booleana. Se si utilizza il tipo System.Threading.Tasks.Task e si attende il completamento dell'attività nel thread chiamante, è possibile utilizzare il metodo ThrowIfCancellationRequested per controllare la proprietà e generare l'eccezione. Utilizzando questo metodo, si garantisce che venga generata l'eccezione corretta in risposta a una richiesta. Se si utilizza un oggetto Task, la chiamata a questo metodo è pertanto preferibile rispetto alla generazione manuale di un evento OperationCanceledException. Se non è necessario generare l'eccezione, è quindi sufficiente controllare la proprietà e ottenere un risultato dal metodo se la proprietà è true.
Class CancelByPolling
Shared Sub Main()
Dim tokenSource As New CancellationTokenSource()
' Toy object for demo purposes
Dim rect As New Rectangle()
rect.columns = 1000
rect.rows = 500
' Simple cancellation scenario #1. Calling thread does not wait
' on the task to complete, and the user delegate simply returns
' on cancellation request without throwing.
Task.Factory.StartNew(Sub() NestedLoops(rect, tokenSource.Token), tokenSource.Token)
' Simple cancellation scenario #2. Calling thread does not wait
' on the task to complete, and the user delegate throws
' OperationCanceledException to shut down task and transition its state.
' Task.Factory.StartNew(Sub() PollByTimeSpan(tokenSource.Token), tokenSource.Token)
Console.WriteLine("Press 'c' to cancel")
If Console.ReadKey().KeyChar = "c"c Then
tokenSource.Cancel()
Console.WriteLine("Press any key to exit.")
End If
Console.ReadKey()
End Sub
Shared Sub NestedLoops(ByVal rect As Rectangle, ByVal token As CancellationToken)
For x As Integer = 0 To rect.columns
For y As Integer = 0 To rect.rows
' Simulating work.
Thread.SpinWait(5000)
Console.Write("0' end block,1' end block ", x, y)
Next
' Assume that we know that the inner loop is very fast.
' Therefore, checking once per row is sufficient.
If token.IsCancellationRequested = True Then
' Cleanup or undo here if necessary...
Console.WriteLine("\r\nCancelling after row 0' end block.", x)
Console.WriteLine("Press any key to exit.")
' then...
Exit For
' ...or, if using Task:
' token.ThrowIfCancellationRequested()
End If
Next
End Sub
End Class
class CancelByPolling
{
static void Main()
{
var tokenSource = new CancellationTokenSource();
// Toy object for demo purposes
Rectangle rect = new Rectangle() { columns = 1000, rows = 500 };
// Simple cancellation scenario #1. Calling thread does not wait
// on the task to complete, and the user delegate simply returns
// on cancellation request without throwing.
Task.Factory.StartNew(() => NestedLoops(rect, tokenSource.Token), tokenSource.Token);
// Simple cancellation scenario #2. Calling thread does not wait
// on the task to complete, and the user delegate throws
// OperationCanceledException to shut down task and transition its state.
// Task.Factory.StartNew(() => PollByTimeSpan(tokenSource.Token), tokenSource.Token);
Console.WriteLine("Press 'c' to cancel");
if (Console.ReadKey().KeyChar == 'c')
{
tokenSource.Cancel();
Console.WriteLine("Press any key to exit.");
}
Console.ReadKey();
}
static void NestedLoops(Rectangle rect, CancellationToken token)
{
for (int x = 0; x < rect.columns && !token.IsCancellationRequested; x++)
{
for (int y = 0; y < rect.rows; y++)
{
// Simulating work.
Thread.SpinWait(5000);
Console.Write("{0},{1} ", x, y);
}
// Assume that we know that the inner loop is very fast.
// Therefore, checking once per row is sufficient.
if (token.IsCancellationRequested)
{
// Cleanup or undo here if necessary...
Console.WriteLine("\r\nCancelling after row {0}.", x);
Console.WriteLine("Press any key to exit.");
// then...
break;
// ...or, if using Task:
// token.ThrowIfCancellationRequested();
}
}
}
}
La chiamata a ThrowIfCancellationRequested è estremamente veloce e non comporta un sovraccarico significativo nei cicli.
Se si chiama ThrowIfCancellationRequested è solo necessario controllare in modo esplicito la proprietà IsCancellationRequested se sono presenti altre attività da eseguire in risposta all'annullamento oltre alla generazione dell'eccezione. In questo esempio è possibile vedere come il codice in effetti acceda alla proprietà due volte: una volta tramite accesso esplicito e di nuovo nel metodo ThrowIfCancellationRequested. Poiché tuttavia l'operazione di lettura della proprietà IsCancellationRequested comporta solo un'istruzione di lettura volatile per accesso, il doppio accesso non è significativo dal punto di vista prestazionale. È comunque preferibile chiamare il metodo anziché generare manualmente l'evento OperationCanceledException.