TcpClient.SendTimeout プロパティ

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

TcpClient.SendTimeout プロパティ

送信操作が正常に完了するのを TcpClient が待機する時間を取得または設定します。

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

Visual Basic (宣言)

Public Property SendTimeout As
 Integer

Visual Basic (使用法)

Dim instance As TcpClient
Dim value As Integer

value = instance.SendTimeout

instance.SendTimeout = value

C#

public int SendTimeout { get;
 set; }

C++

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

J#

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

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

JScript

public function get SendTimeout
 () : int

public function set SendTimeout
 (value : int)

プロパティ値
ミリ秒単位の送信タイムアウト値。既定値は 0 です。

解説

SendTimeout プロパティは、正常に終了できるまで Send メソッドがブロックする時間を決定します。時間の単位はミリ秒です。

Write メソッドを呼び出すと、基になる Socket はホストに実際に送信されたバイト数を返します。SendTimeout プロパティは、返されたバイト数を受信する前に TcpClient が待機する時間を決定します。Send メソッドが正常に完了する前にタイムアウトが発生した場合、TcpClient は SocketException をスローします。既定では、タイムアウトは発生しません。

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

使用例

SendTimeout 値を設定および取得するコード例を次に示します。

Visual Basic

' Sets the send time out using the SendTimeout public property.
tcpClient.SendTimeout = 5000

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

C#

// sets the send time out using the SendTimeout public property.
tcpClient.SendTimeout = 5;

// gets the send time out using the SendTimeout public property.
if (tcpClient.SendTimeout == 5)
    Console.WriteLine ("The send time out limit was successfully set
 " + tcpClient.SendTimeout.ToString ());

C++

// sets the send time out using the SendTimeout public property.
tcpClient->SendTimeout = 5;

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

J#

// sets the send time out using the SendTimeout public property.
tcpClient.set_SendTimeout(5);

// gets the send time out using the SendTimeout public property.
if (tcpClient.get_SendTimeout() == 5) {
    Console.WriteLine("The send time out limit was successfully set
 "
        + ((Int32)tcpClient.get_SendTimeout()).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 名前空間
Write
TcpClient.ReceiveTimeout プロパティ