【C#】クライアント側のSocket通信のタイムアウト設定について

2021年10月26日2023年5月6日

URLをコピーしました！

どうも、〇NAKA（マルナカ）です。

これまでTCP/IPのソケット通信によるクライアント側の通信手順やC#でコードを記述する方法を記事にまとめました。（以下のリンクカードからアクセスすることができます）

Soket通信のタイムアウト処理

ここではいくつかの設定方法について紹介します。

WaitHandle.WaitOne(int millisecoundsTimeout)を使用する

クライアントのSoket通信の記事で紹介しているサンプルにタイムアウト処理を追加した例が以下になります。

try
{
    // IPアドレスとポート番号を取得
    IPEndPoint endpoint = new IPEndPoint(IPAddress.Parse(ipaddress), port);

    // TCP/IPのソケットを作成
    using (Socket client = new Socket(IPAddress.Parse(ipaddress).AddressFamily, SocketType.Stream, ProtocolType.Tcp))
    {
        // エンドポイント（IPアドレスとポート）へ接続
        client.BeginConnect(endpoint, new AsyncCallback(ConnectCallback), client);
        if (!connectDone.WaitOne(1000))
        {
            //タイムアウトの例外
            throw new SocketException(10060);
        }

        // 接続後の処理を記述

        // ソケット接続終了
        client.Shutdown(SocketShutdown.Both);
    }
}
catch (Exception e)
{
    Debug.WriteLine(ex.Message);
}

非同期のSoket通信で接続処理をするBeginConnectは、接続の有無に関わらず次の処理を実行します。なのでManualResetEventのシグナル状態を監視して、接続ができていない場合は、次の処理が実行されないように待機するようにしています。シグナル状態を監視するWaitOne()に数値を引数で渡すと、指定された数値でタイムアウトをします。

ManualResetEventを使いたくない場合は、BeginConnectの返り値であるIAsyncResultからWaitHandleを取得し、WaitOneでタイムアウト処理を記述します。その方法が以下になります。

try
{
    // IPアドレスとポート番号を取得
    IPEndPoint endpoint = new IPEndPoint(IPAddress.Parse(ipaddress), port);

    // TCP/IPのソケットを作成
    using (Socket client = new Socket(IPAddress.Parse(ipaddress).AddressFamily, SocketType.Stream, ProtocolType.Tcp))
    {
        // エンドポイント（IPアドレスとポート）へ接続
        var ar = client.BeginConnect(endpoint, new AsyncCallback(ConnectCallback), client);
        var ret = ar.AsyncWaitHandle.WaitOne(1000, true);
        if (!ret)
        {
            //タイムアウトの例外
            throw new SocketException(10060);
        }

        // 接続後の処理を記述

        // ソケット接続終了
        client.Shutdown(SocketShutdown.Both);
    }
}
catch (Exception ex)
{
    Debug.WriteLine(ex.Message);
}

これらの方法には１つ欠点があり、タイムアウトされるまでデッドロックが発生します。接続シグナルを受信するまでスレッドがブロッグされる為、待機している1秒間はUIが操作不可能になってしまいます。

ブロッグされる同期処理をTask.Run()を使って別スレッドで実行することで、接続待機中のUI画面のフリーズを改善することができます。Task.Run()は簡単に非同期で処理をすることが実現できるのでとても便利です。

try
{
    // IPアドレスとポート番号を取得
    IPEndPoint endpoint = new IPEndPoint(IPAddress.Parse(ipaddress), port);

    // TCP/IPのソケットを作成
    using (Socket client = new Socket(IPAddress.Parse(ipaddress).AddressFamily, SocketType.Stream, ProtocolType.Tcp)) 
    {
        // エンドポイント（IPアドレスとポート）へ接続
        var ar = client.BeginConnect(endpoint, new AsyncCallback(ConnectCallback), client);
        var ret = await Task.Run(() => ar.AsyncWaitHandle.WaitOne(1000, true));
        if (!ret)
        {
            //タイムアウトの例外
            throw new SocketException(10060);
        }

        // 接続後の処理を記述

        // ソケット接続終了
        client.Shutdown(SocketShutdown.Both);
    }
}
catch (Exception ex)
{
    Debug.WriteLine(ex.Message);
}