This documentation is archived and is not being maintained.

TcpClient.Client Property

Gets or sets the underlying Socket.

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

public Socket Client { get; set; }

Property Value

Type: System.Net.Sockets.Socket
The underlying network Socket.

TcpClient creates a Socket to send and receive data over a network. Classes deriving from TcpClient can use this property to get or set this Socket. Use the underlying Socket returned from Client if you require access beyond that which TcpClient provides. You can also use Client to set the underlying Socket to an existing Socket. This might be useful if you want to take advantage of the simplicity of TcpClient using a pre-existing Socket.

The following code example demonstrates the use of the Client property. In this example, the receive buffer size of the underlying Socket is changed.

TcpClient client = new TcpClient();
Socket s = client.Client;

if (!s.Connected)
{
    s.SetSocketOption(SocketOptionLevel.Socket, 
                 SocketOptionName.ReceiveBuffer, 16384);
    Console.WriteLine(
        "client is not connected, ReceiveBuffer set\n");
}
else
   Console.WriteLine("client is connected");
TcpClient* client = new TcpClient();
Socket* s = client->Client;

if (!s->Connected)
{
    s->SetSocketOption(SocketOptionLevel::Socket, 
                       SocketOptionName::ReceiveBuffer, 16384);
    Console::WriteLine(S"client is not connected, ReceiveBuffer set\n");
}
else
    Console::WriteLine(S"client is connected");

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

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0
Show: