【C#】TcpClientのConnectのタイムアウト設定

2024年3月11日

当ページのリンクには広告が含まれています。

URLをコピーしました！

このブログでは、TCP 通信のクライアント側の通信手順や C# でコードを記述する方法をまとめました。（以下のリンクカードから確認出来ます。）

あわせて読みたい

【C#】TcpClientでクライアントの通信処理を作成 TCP/IP 通信は確実にデータの送受信ができるので通信品質が高く、現在でも使用されている通信手段の１つとして使用されています。 C# で TCP/IP 通信を非同期処理でプロ…

実際に TCP 通信を使うことになった際、クライアントはサーバーへリクエストを送信する為に頻繁に接続を要求することになります。サーバーが接続待ちの状態であれば通信を確立させることができますが、サーバーが接続待ち状態ではない場合だったらクライアントの接続は失敗してしまいます。

TcpClient の Connect（非同期なら ConnectAsync）は約２１秒経過してからタイムアウトします。下図のようにタイムアウトされるまでクライアントは長時間待たなければなりません。

TCP のタイムアウトは、サーバーから応答が返ってくるまで一定時間待ちます。１回目は3秒間待ちます。３秒間待って応答がなかったら、次は６秒間待ちます。6秒待って応答がなかったら、１２秒間待ちます。２回リトライして接続できなかったらタイムアウトで例外を吐くという仕組みになっています。この待ち時間の合計が２１秒（３秒＋６秒＋１２秒）になるということです。（参考）

この記事では TcpClient の接続タイムアウトの時間を任意の値に設定する方法について紹介しています。是非参考にしてみてください。

あわせて読みたい

【C#】おすすめする入門書（参考書）５選を紹介！ C# とはマイクロソフトが開発したプログラミング言語であり、Windows向けのアプリケーション開発から、Android向けのアプリケーション開発、Web向けのアプリケーション…

オススメの参考書

C#の使い方が丁寧に解説しており、「基礎からしっかりと学びたい」という初心者の方にオススメの一冊です。サンプルコードも記載してあり、各章の最後に復習問題があるので理解度を確認しながら読み進めることができます。新しい C# のバージョンにも対応している書籍です。

基礎からしっかり学ぶC#の教科書第3版 C# 10対応

Amazon

楽天市場

Yahooショッピング

ポチップ

TcpClientのタイムアウト処理

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

①Task.Wait()を使用する

ConnectAsyncのタスクの実行が完了するまで指定されたミリ秒以内の間だけ待機する方法です。

try
{
    using (var tcpclient = new TcpClient())
    {
        //タイムアウトの時間を設定
        var timeout = 1000;
        var task = tcpclient.ConnectAsync(ipaddress, port);
        if (!task.Wait(timeout))  //ここで画面がフリーズしてしまう。
        {
            //タイムアウトの例外
            throw new SocketException(10060);
        }

        //接続後の処理を記述
    }
}
catch (Exception ex)
{
    Debug.WriteLine(ex.Message);
}

上記の例だと接続処理の実行を待機し、１秒間経過しても接続されなかったらタイムアウトの例外を吐きます。

しかし、Waitを使ってしまうとデッドロックが発生するという欠点があります。１秒間待機中している間はUIが操作不可能になってしまいます。これだとあまりよくありませんよね。

②Task.WhenAny()を使用する

指定されたタスクのいずれかが完了してから次の処理に進むWhenAnyを使う方法です。

try
{
    using (var tcpclient = new TcpClient())
    {
        //タイムアウトの時間を設定
        var timeout = 1000;
        var task = tcpclient.ConnectAsync(ipaddress, port);
        if (await Task.WhenAny(task, Task.Delay(timeout)) != task)
        {
            //タイムアウトの例外
            throw new SocketException(10060);
        }

        //接続後の処理を記述 
    }
}
catch (Exception ex)
{
    Debug.WriteLine(ex.Message);
}

ConnectAsyncのタスクもしくは１秒間のタスクを同時に実行して、１秒間のタスクが先に完了したらタイムアウトの例外を吐きます。

この方法ならデッドロックは発生せずに、非同期で実行することが可能です。