Taskabbruch

Die Klassen System.Threading.Tasks.Task und System.Threading.Tasks.Task<TResult> unterstützen den Abbruch mithilfe von Abbruchtoken. Weitere Informationen finden Sie unter Abbruch in verwalteten Threads. In den Taskklassen erfordert ein Abbruch die Zusammenarbeit zwischen dem Benutzerdelegaten, der einen abbrechbaren Vorgang darstellt, und dem Code, der den Abbruch angefordert hat. Für einen erfolgreichen Abbruch muss der anfordernde Code die Methode CancellationTokenSource.Cancel aufrufen und der Benutzerdelegat den Vorgang rechtzeitig beenden. Sie können den Vorgang mithilfe einer dieser Optionen beenden:

• Durch eine Rückkehr vom Delegaten. In vielen Szenarien ist diese Option ausreichend. Eine auf diese Weise abgebrochene Aufgabeninstanz geht jedoch in den Zustand TaskStatus.RanToCompletion statt in den Zustand TaskStatus.Canceled über.

• Durch Auslösen einer OperationCanceledException und Übergeben des Tokens, in dem der Abbruch angefordert wurde. Das bevorzugte Verfahren hierfür ist die ThrowIfCancellationRequested-Methode. Eine auf diese Weise abgebrochene Aufgabe geht in den Zustand „Abgebrochen“ über, anhand dessen der aufrufende Code überprüfen kann, ob die Aufgabe auf seine Abbruchanforderung reagiert hat.

Im folgenden Beispiel wird das grundlegende Muster für den Aufgabenabbruch gezeigt, der die Ausnahme auslöst:

Hinweis

Das Token wird an den Benutzerdelegaten und die Aufgabeninstanz übergeben.

using System;
using System.Threading;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        var tokenSource2 = new CancellationTokenSource();
        CancellationToken ct = tokenSource2.Token;

        var task = Task.Run(() =>
        {
            // Were we already canceled?
            ct.ThrowIfCancellationRequested();

            bool moreToDo = true;
            while (moreToDo)
            {
                // Poll on this property if you have to do
                // other cleanup before throwing.
                if (ct.IsCancellationRequested)
                {
                    // Clean up here, then...
                    ct.ThrowIfCancellationRequested();
                }
            }
        }, tokenSource2.Token); // Pass same token to Task.Run.

        tokenSource2.Cancel();

        // Just continue on this thread, or await with try-catch:
        try
        {
            await task;
        }
        catch (OperationCanceledException e)
        {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
        finally
        {
            tokenSource2.Dispose();
        }

        Console.ReadKey();
    }
}

Imports System.Threading
Imports System.Threading.Tasks

Module Test
    Sub Main()
        Dim tokenSource2 As New CancellationTokenSource()
        Dim ct As CancellationToken = tokenSource2.Token

        Dim t2 = Task.Factory.StartNew(Sub()
                                           ' Were we already canceled?
                                           ct.ThrowIfCancellationRequested()

                                           Dim moreToDo As Boolean = True
                                           While moreToDo = True
                                               ' Poll on this property if you have to do
                                               ' other cleanup before throwing.
                                               If ct.IsCancellationRequested Then

                                                   ' Clean up here, then...
                                                   ct.ThrowIfCancellationRequested()
                                               End If

                                           End While
                                       End Sub _
        , tokenSource2.Token) ' Pass same token to StartNew.

        ' Cancel the task.
        tokenSource2.Cancel()

        ' Just continue on this thread, or Wait/WaitAll with try-catch:
        Try
            t2.Wait()

        Catch e As AggregateException

            For Each item In e.InnerExceptions
                Console.WriteLine(e.Message & " " & item.Message)
            Next
        Finally
            tokenSource2.Dispose()
        End Try

        Console.ReadKey()
    End Sub
End Module

Ein vollständiges Beispiel finden Sie unter Gewusst wie: Abbrechen einer Aufgabe und ihrer untergeordneten Elemente.

Wenn eine Aufgabeninstanz eine OperationCanceledException beobachtet, die von Benutzercode ausgelöst wurde, vergleicht sie das Token der Ausnahme mit dem zugeordneten Token (das an die API übergeben wurde, die die Aufgabe erstellt hat). Wenn die Token gleich sind und die IsCancellationRequested-Eigenschaft des Tokens true zurückgibt, interpretiert die Aufgabe dies als Bestätigung des Abbruchs und geht in den Zustand „Abgebrochen“ über. Wenn Sie nicht mithilfe einer Wait- oder WaitAll-Methode auf die Aufgabe warten, wird der Status der Aufgabe einfach auf Canceled festgelegt.

Wenn Sie auf eine Aufgabe warten, die in den Zustand „Abgebrochen“ übergeht, wird eine System.Threading.Tasks.TaskCanceledException-Ausnahme (eingebunden in eine AggregateException-Ausnahme) ausgelöst. Beachten Sie, dass diese Ausnahme keinen Fehler, sondern einen erfolgreichen Abbruch kennzeichnet. Daher gibt die Eigenschaft Exception der Aufgabe nullzurück.

Wenn die IsCancellationRequested-Eigenschaft des Tokens false zurückgibt oder das Token der Ausnahme nicht mit dem Token der Aufgabe übereinstimmt, wird die OperationCanceledException wie eine normale Ausnahme behandelt, durch die die Aufgabe in den Zustand „Fehlerhaft“ übergeht. Die Gegenwart weiterer Ausnahmen führt ebenfalls dazu, dass die Aufgabe in den Zustand „Fehlerhaft“ übergeht. Sie können den Status der abgeschlossenen Aufgabe in der Status -Eigenschaft abrufen.

Es ist möglich, dass eine Aufgabe nach dem Anfordern des Abbruchs noch mit der Verarbeitung einiger Elemente fortfährt.

Siehe auch

• Abbruch in verwalteten Threads
• How to: Abbrechen einer Aufgabe und ihrer untergeordneten Elemente