C# / 非同期処理の時間後キャンセル

Question

C#の質問です。

async/awitを使用しての非同期処理時における時間後キャンセルについてです。
現状記載のコードとしていますが、実現したい動きとなりません。
(処理開始後、5秒後には処理キャンセルとして例外処理を行いたく。)

よろしくお願いします。

実現したい動きは下記です。
・2つの処理を非同期に実施
・正常終了した場合は戻り値をTrue
5秒後に終了していない場合は戻り値をFalse

    private async Task<bool> ExecParallelTask()
    {
        bool isFinishedCorrectly;

        // Set CancelTimer = 5 sec
        var cts = new CancellationTokenSource();
        cts.CancelAfter(5000);

        try
        {        
            // Execute in parallel
            var tasks = new List<Task>();
            tasks.Add(Task.Run(() => HeavyTask1(), cts.Token));
            tasks.Add(Task.Run(() => HeavyTask2(), cts.Token));

            // Wait for all finish
            await Task.WhenAll(tasks.ToArray());
            
            // Finish: Set bool = true
            isFinishedCorrectly = true;
        }
        catch (TaskCanceledException)
        {
            // Cancel: Set bool = false
            isFinishedCorrectly = false;
        }
        finally
        {
            cts.Dispose();
        }

        return isFinishedCorrectly
    }

    private void HeavyTask1()
    {
        重い処理
    }

    private void HeavyTask2()
    {
        重い処理
    }

Comments

[退会済みユーザー]

アプリは何か（WinFroms? WPF? コンソールアプリ？ その他？）と開発環境（OS, Visual Studio のバージョン、.NET Framework or Core のどちらかとそのバージョン）を書いてください。

> 実現したい動きとなりません。

「実現したい動き」とは具体的に何で、現状はどうなるのですか？

[退会済みユーザー]

質問者さん、無言ですが、レスが付いているのでそれに対するフィードバックを書きましょう。役に立った/立たなかったぐらいの返事はできるのでは？　役に立たなかったなら、どこがダメなのか書いてもらえると、より期待する回答が出てくるかも。とにかく無言は NG です。

[keruuuu]

返信遅くなり申し訳ありません。
ご指摘ありがとうございます。
まだ動作等確認できていないため、確認後またUPDATEさせて頂きます。

Answer 1

HeavyTask1, HeavyTask2 メソッドの引数で CancellationToken を受けて、キャンセルされたら CancellationToken.ThrowIfCancellationRequested() で OperationCanceledException をスローするようにし、ExecParallelTask メソッドでそれを catch するようにしてはいかがですか？

具体例は以下のコードを見てください。.NET Framework 4.8 の Windows Forms アプリです。

using System;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace WindowsFormsAsyncTest
{
    public partial class Form5 : Form
    {
        private CancellationTokenSource cts = null;

        public Form5()
        {
            InitializeComponent();
            EableButtons();
        }

        // RunProcTaskAsync 起動
        private async void button1_Click(object sender, EventArgs e)
        {           
            DisableButtons();
            this.textBox1.Text = "RunProcTaskAsync 起動";

            var p = new Progress<string>(ShowProgress);

            using (this.cts = new CancellationTokenSource())
            {
                // 起動してから 5 秒後にキャンセル
                this.cts.CancelAfter(5000);

                CancellationToken token = this.cts.Token;
                try
                {
                    await RunProcTaskAsync(p, token);
                }
                catch (OperationCanceledException)
                {
                    // 必要なら何らかの処置
                }
            }

            EableButtons();
        }

        // キャンセル
        private void button2_Click(object sender, EventArgs e)
        {
            if (this.cts != null) cts.Cancel();
        }

        // RunProcTask 起動
        private async void button3_Click(object sender, EventArgs e)
        {
            DisableButtons();
            this.textBox1.Text = "RunProcTask 起動";

            var p = new Progress<string>(ShowProgress);

            using (this.cts = new CancellationTokenSource())
            {
                // 起動してから 5 秒後にキャンセル
                this.cts.CancelAfter(5000);

                CancellationToken token = this.cts.Token;
                try
                {                    
                    await Task.Run(() => RunProcTask(p, token));
                }
                catch (OperationCanceledException)
                {
                    // 必要なら何らかの処置
                }
            }

            EableButtons();
        }


        // 処理タスク
        // ポーリングによるキャンセルのリッスン
        //  IProgress<T>/Progress<T> で進捗をレポート
        private async Task RunProcTaskAsync(IProgress<string> progress, CancellationToken token)
        {
            int i = 0;
            while (true)
            {
                token.ThrowIfCancellationRequested();
                await Task.Delay(1000);
                progress.Report(i.ToString());
                i++;
            }
        }

        private void RunProcTask(IProgress<string> progress, CancellationToken token)
        {
            int i = 0;
            while (true)
            {
                token.ThrowIfCancellationRequested();
                Thread.Sleep(1000);
                progress.Report(i.ToString());
                i++;
            }
        }

        // 進捗を TextBox に表示するコールバック
        // UIスレッドで呼び出される
        private void ShowProgress(string log)
        {
            this.textBox1.Text = "ログ出力その " + log;
        }

        // ボタンの Enable / Disable を切り替えるヘルパメソッド
        private void DisableButtons()
        {
            button1.Enabled = false;
            button2.Enabled = true;
            button3.Enabled = false;
        }

        private void EableButtons()
        {
            button1.Enabled = true;
            button2.Enabled = false;
            button3.Enabled = true;
        }

        
    }
}

実行結果は以下のようになります。［RunProcTask 起動］ボタンクリックで同期版のメソッド RunProcTask を Task.Run で起動し、そのボタンのハンドラに追加した this.cts.CancelAfter(5000); により 5 秒後にキャンセルされたところです。

【追記】

キャンセル処理の基本は Microsoft のドキュメント「マネージド スレッドのキャンセル」（URL 下記）に書いてありますので読んでみてください。

マネージド スレッドのキャンセル
https://docs.microsoft.com/ja-jp/dotnet/standard/threading/cancellation-in-managed-threads

それに書いてありますが、キャンセル処理を実装するための一般的なパターンは以下の通りだそうです。

1. CancellationTokenSource クラスのインスタンスを作成する。
2. CancellationTokenSource.Token プロパティで CancellationToken を取得し、キャンセルをリッスンするタスクに渡す。 　
3. タスクにはキャンセル通知を適切に処置するコードを実装しておく。
4. CancellationTokenSource.Cancel メソッドを呼び出し、リッスンしているタスクにキャンセルを通知する。
5. キャンセル通知を受けたタスクは、あらかじめ実装されているコードに従ってキャンセル処置を行う。

　

タスクがキャンセルの通知を受けとるには、(1) ポーリング、(2) コールバックの登録、(3) 待機ハンドルの待機という方法があるそうです。上のコード例は (1) を使っています。

Answer 2

HeavyTask内で、CancellationTokenSourceのIsCancellationRequestedを判定して処理を打ち切るようなコードを入れないとダメです。
あと、HeaveTaskが戻り値の無い非同期処理なら、voidではなくasync Taskにしましょう。Task内で例外が発生しても上位で受け取る事が出来ない等、色々問題が発生します。