C#でタスクを中断する

この記事は2020年04月24日に投稿しました。

目次

1. はじめに
2. C#でタスクを中断する
3. おわりに

リンク

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回は業務で使用しているC#でタスクを中断する方法についてです。

目次へ

2. C#でタスクを中断する

C#でタスクを中断するには、CancellationTokenSourceクラスとCancellationToken構造体を使用します。

実装例

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

namespace CSharpCancelletionToken
{
    class Program
    {
        static void Main(string[] args)
        {
            // タスクを開始します。
            var program = new Program();
            program.StartTask();

            Console.ReadKey();
        }

        /**
         * @brief タスクを開始します。
         */
        private void StartTask()
        {
            // キャンセルトークンソースを生成し、キャンセルトークンを取得します。
            var tokenSource = new CancellationTokenSource();
            var token = tokenSource.Token;

            // タスクにキャンセルトークンを渡し、タスクを開始します。
            Task.Run(() => MyAction(token));

            Thread.Sleep(1000);

            // タスクをキャンセルします。
            Console.WriteLine("Cancel");
            tokenSource.Cancel();
        }

        /**
         * @brief タスクの処理
         * 
         * @param [in] token キャンセルトークン
         */
        private void MyAction(CancellationToken token)
        {
            Console.WriteLine("MyAction start.");

            // キャンセルされるまで繰り返します。
            var counter = 0;
            while (true)
            {
                Console.WriteLine($"counter={++counter}");

                Thread.Sleep(100);

                // キャンセルされた場合
                if (token.IsCancellationRequested)
                {
                    // ループを終了します。
                    break;
                }
            }
            Console.WriteLine("MyAction exit.");
        }
    }
}

実行結果

MyAction start.
counter=1
counter=2
counter=3
counter=4
counter=5
counter=6
counter=7
counter=8
counter=9
counter=10
Cancel
MyAction exit.

API Reference

CancellationTokenSourceクラス

CancellationToken構造体

目次へ

3. おわりに

タスクを中断するにはよくフラグなどを使用していました。
今回別の方法を知ったので、紹介します。

リンク

紹介している一部の記事のコードはGitlabで公開しています。
興味のある方は覗いてみてください。

目次へ

---

私が勤務しているニューラルでは、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS Bi-OSは高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ