タスクの取り消し

System.Threading.Tasks.TaskクラスとSystem.Threading.Tasks.Task<TResult> クラスでは、キャンセル トークンを使用したキャンセルがサポートされます。 詳細については、「 マネージド スレッドでの取り消し」を参照してください。 Task クラスでは、取り消し可能な操作を表すユーザー デリゲートと、取り消しを要求したコードの間の連携が伴います。 取り消しが成功すると、 CancellationTokenSource.Cancel メソッドを呼び出す要求コードと、ユーザー デリゲートがタイムリーに操作を終了する必要があります。 次のいずれかのオプションを使用して、操作を終了できます。

• デリゲートから返す。 多くのシナリオでは、このオプションで十分です。 ただし、この方法で取り消されたタスク インスタンスは、TaskStatus.Canceled状態ではなく、TaskStatus.RanToCompletion状態に遷移します。

• OperationCanceledExceptionをスローし、キャンセルが要求されたトークンを渡します。 推奨される実行方法は、 ThrowIfCancellationRequested メソッドを使用する方法です。 この方法で取り消されたタスクは Canceled 状態に遷移します。この状態は、呼び出し元のコードを使用して、タスクが取り消し要求に応答したことを確認するために使用できます。

次の例は、例外をスローするタスクの取り消しの基本的なパターンを示しています。

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

完全な例については、「 方法: タスクとその子を取り消す」を参照してください。

タスク インスタンスは、ユーザー コードによってスローされた OperationCanceledException を観察すると、例外のトークンを関連付けられたトークン (タスクを作成した API に渡されたもの) と比較します。 トークンが同じで、トークンの IsCancellationRequested プロパティが trueを返す場合、タスクはこれを取り消しの確認と解釈し、Canceled 状態に遷移します。 WaitまたはWaitAllメソッドを使用してタスクを待機しない場合、タスクは状態をCanceledに設定するだけです。

Canceled 状態に遷移するタスクを待機している場合は、 System.Threading.Tasks.TaskCanceledException 例外 ( AggregateException 例外でラップ) がスローされます。 この例外は、問題のある状況ではなく、取り消しが成功したことを示します。 したがって、タスクの Exception プロパティは nullを返します。

トークンの IsCancellationRequested プロパティが false を返す場合、または例外のトークンがタスクのトークンと一致しない場合、 OperationCanceledException は通常の例外のように扱われ、タスクは Faulted 状態に遷移します。 他の例外が存在すると、タスクも障害状態に遷移します。 完了したタスクの状態は、 Status プロパティで取得できます。

取り消しが要求された後も、タスクが一部のアイテムを処理し続ける可能性があります。

こちらも参照ください

• マネージド スレッドでの取り消し
• 方法: タスクとその子を取り消す