TcpClient.Connected プロパティ

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

TcpClient.Connected プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

TcpClient の基になる Socket がリモート ホストに接続されているかどうかを示す値を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 Connected As Boolean

Visual Basic (使用法)

Dim instance As TcpClient
Dim value As Boolean

value = instance.Connected

C#

public bool Connected { get;
 }

C++

public:
property bool Connected {
    bool get ();
}

J#

/** @property */
public boolean get_Connected ()

JScript

public function get Connected
 () : boolean

プロパティ値
最後に実行された操作の時点で、Client ソケットがリモート リソースに接続されていた場合は true。それ以外の場合は false。

解説

Connected プロパティは、I/O 操作が最後に実行された時点での Client ソケットの接続状態を取得します。false が返された場合、Client ソケットは一度も接続されていないか、接続が切断されています。

Connected プロパティは最後に実行された操作の時点における接続状態だけを反映するので、現在の状態を確認するには、メッセージの送受信を行ってみる必要があります。このプロパティは、メッセージの送信が一度失敗すると、それ以後 true を返さなくなります。この動作は設計に基づくものです。いずれにせよ、接続状態をテストをするための完全な方法はありません。接続は、テストを実行してから実際に送受信が行われるまでの間に失われる可能性もあるからです。したがって開発者は、ソケットが接続されているものと仮定したうえでコードを記述し、送信が失敗した場合のエラー処理を適切に実装する必要があります。

使用例

リモート エンドポイントに接続し、接続を検証するコード例を次に示します。

C#

static void GetConnected()
{
    // Find out whether the socket is connected to the remote 
    // host.
    Console.WriteLine("Connected value is {0}", t.Connected);
}

C++

static void GetConnected( TcpClient^ t )
{
   // Find out whether the socket is connected to the remote 
   // host.
   Console::WriteLine( "Connected value is {0}", t->Connected.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

参照

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