TcpClient.Client Property (System.Net.Sockets)

Client Property

.NET Framework Class Library

TcpClient..::.Client Property

Gets or sets the underlying Socket.

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

Syntax

Visual Basic (Declaration)

Public Property Client As Socket

Visual Basic (Usage)

Dim instance As TcpClient
Dim value As Socket

value = instance.Client

instance.Client = value

public Socket Client { get; set; }

Visual C++

public:
property Socket^ Client {
    Socket^ get ();
    void set (Socket^ value);
}

JScript

public function get Client () : Socket
public function set Client (value : Socket)

Property Value

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

Remarks

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.

Examples

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

Visual Basic

Dim client As New TcpClient()
Dim s As Socket = client.Client

If Not s.Connected Then
   s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReceiveBuffer, 16384)
   Console.WriteLine("client is not connected, ReceiveBuffer set" + ControlChars.Lf)
Else
   Console.WriteLine("client is connected")
End If

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");

CPP_OLD

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");

Platforms

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.

Version Information

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0

Reference

TcpClient Class

TcpClient Members

System.Net.Sockets Namespace

Socket