c# - C# コンソール アプリで ctrl-c (SIGINT) をトラップする方法

Question

終了する前にいくつかのクリーンアップを実行できるように、C# コンソール アプリケーションでCTRL+をトラップできるようにしたいと考えています。Cこれを行う最善の方法は何ですか？

Answer 1

Console.CancelKeyPressイベントはこれに使用されます。使用方法は次のとおりです。

public static void Main(string[] args)
{
    Console.CancelKeyPress += delegate {
        // call methods to clean up
    };

    while (true) {}
}

ユーザーがCtrl+Cを押すと、デリゲートのコードが実行され、プログラムが終了します。これにより、必要なメソッドを呼び出してクリーンアップを実行できます。デリゲートが実行された後はコードがないことに注意してください。

これがそれをカットしない他の状況があります。たとえば、プログラムが現在、すぐに停止できない重要な計算を実行している場合です。その場合、正しい戦略は、計算が完了した後にプログラムを終了するように指示することかもしれません。次のコードは、これを実装する方法の例を示しています。

class MainClass
{
    private static bool keepRunning = true;

    public static void Main(string[] args)
    {
        Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e) {
            e.Cancel = true;
            MainClass.keepRunning = false;
        };
        
        while (MainClass.keepRunning) {
            // Do your work in here, in small chunks.
            // If you literally just want to wait until ctrl-c,
            // not doing anything, see the answer using set-reset events.
        }
        Console.WriteLine("exited gracefully");
    }
}

このコードと最初の例の違いは、e.Canceltrueに設定されていることです。これは、デリゲートの後で実行が続行されることを意味します。実行すると、プログラムはユーザーがCtrl + Cを押すのを待ちます。それが発生すると、keepRunning変数の値が変更され、whileループが終了します。これは、プログラムを正常に終了させる方法です。

Answer 2

MSDN を参照してください:

Console.CancelKeyPress イベント

コード サンプルを含む記事:

Ctrl-C と .NET コンソール アプリケーション

Answer 3

ジョナスの答えに追加したいと思います。a でスピンすると、CPU 使用率が 100% になり、 +boolを待っている間、何もせずに大量のエネルギーを浪費します。CTRLC

より良い解決策は、 +ManualResetEventを実際に「待機」するためにa を使用することです。CTRLC

static void Main(string[] args) {
    var exitEvent = new ManualResetEvent(false);

    Console.CancelKeyPress += (sender, eventArgs) => {
                                  eventArgs.Cancel = true;
                                  exitEvent.Set();
                              };

    var server = new MyServer();     // example
    server.Run();

    exitEvent.WaitOne();
    server.Stop();
}

Answer 4

これは完全な作業例です。空の C# コンソール プロジェクトに貼り付けます。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading;

namespace TestTrapCtrlC {
    public class Program {
        static bool exitSystem = false;

        #region Trap application termination
        [DllImport("Kernel32")]
        private static extern bool SetConsoleCtrlHandler(EventHandler handler, bool add);

        private delegate bool EventHandler(CtrlType sig);
        static EventHandler _handler;

        enum CtrlType {
            CTRL_C_EVENT = 0,
            CTRL_BREAK_EVENT = 1,
            CTRL_CLOSE_EVENT = 2,
            CTRL_LOGOFF_EVENT = 5,
            CTRL_SHUTDOWN_EVENT = 6
        }

        private static bool Handler(CtrlType sig) {
            Console.WriteLine("Exiting system due to external CTRL-C, or process kill, or shutdown");

            //do your cleanup here
            Thread.Sleep(5000); //simulate some cleanup delay

            Console.WriteLine("Cleanup complete");

            //allow main to run off
            exitSystem = true;

            //shutdown right away so there are no lingering threads
            Environment.Exit(-1);

            return true;
        }
        #endregion

        static void Main(string[] args) {
            // Some biolerplate to react to close window event, CTRL-C, kill, etc
            _handler += new EventHandler(Handler);
            SetConsoleCtrlHandler(_handler, true);

            //start your multi threaded program here
            Program p = new Program();
            p.Start();

            //hold the console so it doesn’t run off the end
            while (!exitSystem) {
                Thread.Sleep(500);
            }
        }

        public void Start() {
            // start a thread and start doing some processing
            Console.WriteLine("Thread started, processing..");
        }
    }
}

Answer 5

この質問は次の質問に非常に似ています。

キャプチャ コンソール終了 C#

これが私がこの問題をどのように解決し、ユーザーが X と Ctrl-C を押すかを処理した方法です。ManualResetEvents の使用に注意してください。これらにより、メインスレッドがスリープ状態になり、終了またはクリーンアップを待っている間、CPU が解放されて他のスレッドを処理できるようになります。注: メインの最後に TerminationCompletedEvent を設定する必要があります。そうしないと、アプリケーションの強制終了中に OS がタイムアウトするため、終了時に不要な遅延が発生します。

namespace CancelSample
{
    using System;
    using System.Threading;
    using System.Runtime.InteropServices;

    internal class Program
    {
        /// <summary>
        /// Adds or removes an application-defined HandlerRoutine function from the list of handler functions for the calling process
        /// </summary>
        /// <param name="handler">A pointer to the application-defined HandlerRoutine function to be added or removed. This parameter can be NULL.</param>
        /// <param name="add">If this parameter is TRUE, the handler is added; if it is FALSE, the handler is removed.</param>
        /// <returns>If the function succeeds, the return value is true.</returns>
        [DllImport("Kernel32")]
        private static extern bool SetConsoleCtrlHandler(ConsoleCloseHandler handler, bool add);

        /// <summary>
        /// The console close handler delegate.
        /// </summary>
        /// <param name="closeReason">
        /// The close reason.
        /// </param>
        /// <returns>
        /// True if cleanup is complete, false to run other registered close handlers.
        /// </returns>
        private delegate bool ConsoleCloseHandler(int closeReason);

        /// <summary>
        ///  Event set when the process is terminated.
        /// </summary>
        private static readonly ManualResetEvent TerminationRequestedEvent;

        /// <summary>
        /// Event set when the process terminates.
        /// </summary>
        private static readonly ManualResetEvent TerminationCompletedEvent;

        /// <summary>
        /// Static constructor
        /// </summary>
        static Program()
        {
            // Do this initialization here to avoid polluting Main() with it
            // also this is a great place to initialize multiple static
            // variables.
            TerminationRequestedEvent = new ManualResetEvent(false);
            TerminationCompletedEvent = new ManualResetEvent(false);
            SetConsoleCtrlHandler(OnConsoleCloseEvent, true);
        }

        /// <summary>
        /// The main console entry point.
        /// </summary>
        /// <param name="args">The commandline arguments.</param>
        private static void Main(string[] args)
        {
            // Wait for the termination event
            while (!TerminationRequestedEvent.WaitOne(0))
            {
                // Something to do while waiting
                Console.WriteLine("Work");
            }

            // Sleep until termination
            TerminationRequestedEvent.WaitOne();

            // Print a message which represents the operation
            Console.WriteLine("Cleanup");

            // Set this to terminate immediately (if not set, the OS will
            // eventually kill the process)
            TerminationCompletedEvent.Set();
        }

        /// <summary>
        /// Method called when the user presses Ctrl-C
        /// </summary>
        /// <param name="reason">The close reason</param>
        private static bool OnConsoleCloseEvent(int reason)
        {
            // Signal termination
            TerminationRequestedEvent.Set();

            // Wait for cleanup
            TerminationCompletedEvent.WaitOne();

            // Don't run other handlers, just exit.
            return true;
        }
    }
}

Answer 6

Console.TreatControlCAsInput = true;私のために働いています。