HOWTO · Csharp

C# でディレイタイマーを作る方法

この記事では、C# で遅延タイマーを作る方法を紹介します。Thread.Sleep()、Task.Delay()、System.Timers.Timer、System.Threading.Timer の 4 つの異なる方法を取り上げます。

このページの内容

C# で遅延を追加するには、現在のスレッドをブロックする Thread.Sleep()、非同期に待機する Task.Delay()、コールバックをスケジュールするタイマークラスのいずれかを選択します。以下の例では 2 秒の間隔を使用し、各選択肢がどのように動作するかを示します。これらは提供されたランタイムでは実行されていないため、観測された出力は主張しません。

Thread.Sleep() メソッドを使って C# で遅延を作る

Thread.Sleep() は、指定されたミリ秒数だけ現在のスレッドを一時停止します。そのスレッドは待機中は他の作業を行えないため、この方法は、短い同期コンソールプログラムなど、ブロックが適切な場合にのみ使用してください。

この完全な例では、メッセージを表示し、2 秒待ってから、別のメッセージを表示します。

using System;
using System.Threading;

class DelayExample
{
    static void Main()
    {
        Console.WriteLine("The delay starts.");
        Thread.Sleep(2000);
        Console.WriteLine("The delay ends.");
    }
}

引数はミリ秒単位なので、2000 は 2 秒の待機を要求します。実際に経過する時間は、システムのスケジューリングによって変わることがあります。

Task.Delay() メソッドを使って C# で遅延を作る

Task.Delay() は、要求された間隔の後に完了するタスクを作成します。非同期メソッドでそれを await すると、そのメソッドは待機中に譲ることができます。これは、現在のスレッドを占有する Thread.Sleep() とは異なります。非同期メソッドは、アプリケーションの既存の非同期フローから呼び出してください。

この完全な例では、非同期の待機を別のメソッドに保持し、同期のエントリポイントを使ってそれを呼び出します。

using System;
using System.Threading.Tasks;

class DelayExample
{
    static void Main()
    {
        RunAsync().GetAwaiter().GetResult();
    }

    static async Task RunAsync()
    {
        Console.WriteLine("Before the delay");
        await Task.Delay(2000);
        Console.WriteLine("After the delay");
    }
}

await 式は、遅延タスクが完了した後に RunAsync を再開します。すでに非同期メソッドを使用しているアプリケーションでは、タスクを待つためにエントリポイントをブロックするのではなく、Task.Delay(2000) を直接 await してください。

System.Timers.Timer クラスを使って C# で遅延を作る

System.Timers.Timer は、ミリ秒単位の Interval の後に Elapsed イベントを発生させます。単一のイベントには AutoReset を false に設定し、イベントをその間隔で繰り返す場合は true に設定します。コールバックはイベント駆動なので、タイマーを開始しても次のコード行は一時停止しません。

この完全な例では、コンソールプログラムが終了する前に、1 回限りのイベントを待機します。

using System;
using System.Threading;
using System.Timers;

class DelayExample
{
    static void Main()
    {
        using (var completed = new ManualResetEvent(false))
        using (var timer = new System.Timers.Timer(2000))
        {
            timer.AutoReset = false;
            timer.Elapsed += (sender, args) =>
            {
                Console.WriteLine("Timer elapsed.");
                completed.Set();
            };

            Console.WriteLine("Timer started.");
            timer.Start();
            completed.WaitOne();
        }
    }
}

WaitOne() は、イベントハンドラーが完了を通知するまで、このコンソール例を存続させます。より長時間実行されるアプリケーションでは、タイマーのためだけにブロックする待機を追加するのではなく、通常のイベントループやサービスの存続期間に従ってアプリケーションを存続させてください。

System.Threading.Timer クラスを使って C# で遅延を作る

System.Threading.Timer は、初期の期限と期間を指定してコールバックをスケジュールします。どちらの値もミリ秒単位です。コールバックを 1 回だけ実行する場合は期間に Timeout.Infinite を使用し、繰り返しコールバックをスケジュールする場合は有限の期間を指定します。コールバックは、タイマーを開始するコードとは別に実行されます。

この完全な例では、2 秒後に 1 つのコールバックをスケジュールし、終了する前にそれを待機します。

using System;
using System.Threading;

class DelayExample
{
    static void Main()
    {
        using (var completed = new ManualResetEvent(false))
        using (var timer = new System.Threading.Timer(
            state =>
            {
                Console.WriteLine("Timer callback.");
                completed.Set();
            },
            null,
            2000,
            Timeout.Infinite))
        {
            Console.WriteLine("Timer scheduled.");
            completed.WaitOne();
        }
    }
}

期限により、最初のコールバックは構築の 2 秒後にスケジュールされます。Timeout.Infinite により、別のコールバックがスケジュールされることはありません。この待機により、このコンソール例はコールバックを受け取るのに十分な時間存続します。独自のイベントループを持つアプリケーションでは、代わりにその存続期間を使用できます。

結論

現在のスレッドをブロックすることが許容できる場合は、単純な同期の一時停止に Thread.Sleep() を使用します。非同期コードでは await とともに Task.Delay() を優先し、メソッドが待機中に譲れるようにします。コールバックベースのスケジューリングが必要な場合は System.Timers.Timer または System.Threading.Timer を選択し、AutoReset またはタイマーの期間で繰り返しを制御します。タイマーのコールバックは作業をスケジュールするものであり、逐次実行を一時停止するものではなく、そのタイミングは正確な実時間の保証ではありません。