Export (0) Print
Expand All

TcpClient.Connected Property

Note: This property is new in the .NET Framework version 2.0.

Gets a value indicating whether the underlying Socket for a TcpClient is connected to a remote host.

Namespace: System.Net.Sockets
Assembly: System (in system.dll)

public bool Connected { get; }
/** @property */
public boolean get_Connected ()

public function get Connected () : boolean

Property Value

true if the Client socket was connected to a remote resource as of the most recent operation; otherwise, false.

The Connected property gets the connection state of the Client socket as of the last I/O operation. When it returns false, the Client socket was either never connected, or is no longer connected.

Because the Connected property only reflects the state of the connection as of the most recent operation, you should attempt to send or receive a message to determine the current state. After the message send fails, this property no longer returns true. Note that this behavior is by design. You cannot reliably test the state of the connection because, in the time between the test and a send/receive, the connection could have been lost. Your code should assume the socket is connected, and gracefully handle failed transmissions.

The following code example connects to a remote endpoint and then verifies the connection.

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

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft