TcpClient.ReceiveTimeout プロパティ

.NET Framework クラス ライブラリ リファレンス

TcpClient.ReceiveTimeout プロパティ

読み取り操作が開始された後に TcpClient がデータの受信を待機する時間を取得または設定します。

名前空間: System.Net.Sockets
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Property ReceiveTimeout As
 Integer

Visual Basic (使用法)

Dim instance As TcpClient
Dim value As Integer

value = instance.ReceiveTimeout

instance.ReceiveTimeout = value

C#

public int ReceiveTimeout { get;
 set; }

C++

public:
property int ReceiveTimeout {
    int get ();
    void set (int value);
}

J#

/** @property */
public int get_ReceiveTimeout ()

/** @property */
public void set_ReceiveTimeout (int
 value)

JScript

public function get ReceiveTimeout
 () : int

public function set ReceiveTimeout
 (value : int)

プロパティ値
接続のタイムアウト値 (ミリ秒単位)。既定値は、0 です。

解説

ReceiveTimeout プロパティは、データを受信できるようになるまで Read メソッドがブロックする時間を決定します。時間の単位はミリ秒です。Read が正常に完了する前にタイムアウトが発生した場合、TcpClient は IOException をスローします。既定では、タイムアウトは発生しません。

Windows Mobile for Pocket PC、Windows Mobile for Smartphone、Windows CE プラットフォームメモ : .NET Compact Framework アプリケーションでは、ReceiveTimeout 列挙値はサポートされていますが、今後使用するために予約されています。ReceiveTimeout プロパティはこの列挙値を使用するため、.NET Compact Framework の今後のリリースでその列挙値が使用できるようになるまで、SocketException が発生します。

使用例

受信のタイム アウトを設定および取得するコード例を次に示します。

Visual Basic

' Sets the receive time out using the ReceiveTimeout public property.
tcpClient.ReceiveTimeout = 5

' Gets the receive time out using the ReceiveTimeout public property.
If tcpClient.ReceiveTimeout = 5 Then
   Console.WriteLine(("The receive time out limit was successfully
 set " + tcpClient.ReceiveTimeout.ToString()))
End If

C#

// Sets the receive time out using the ReceiveTimeout public property.
tcpClient.ReceiveTimeout = 5000;

// Gets the receive time out using the ReceiveTimeout public property.
if (tcpClient.ReceiveTimeout == 5000)
    Console.WriteLine ("The receive time out limit was successfully set
 " + tcpClient.ReceiveTimeout.ToString ());

C++

// Sets the receive time out using the ReceiveTimeout public property.
tcpClient->ReceiveTimeout = 5;

// Gets the receive time out using the ReceiveTimeout public property.
if ( tcpClient->ReceiveTimeout == 5 )
      Console::WriteLine( "The receive time out limit was successfully set
 {0}", tcpClient->ReceiveTimeout );

J#

// Sets the receive time out using the ReceiveTimeout public property.
tcpClient.set_ReceiveTimeout(5);

// Gets the receive time out using the ReceiveTimeout public property.
if (tcpClient.get_ReceiveTimeout() == 5) {
    Console.WriteLine("The receive time out limit was successfully set
 "
        + ((Int32)tcpClient.get_ReceiveTimeout()).ToString());
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
TcpClient クラス
TcpClient メンバ
System.Net.Sockets 名前空間
Read
SendTimeout