TcpClient.Connect Method (IPAddress[], Int32) (System.Net.Sockets)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

TcpClient.Connect Method (IPAddress[], Int32)

Connects the client to a remote TCP host using the specified IP addresses and port number.

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

Syntax

Visual Basic

Public Sub Connect ( _
	ipAddresses As IPAddress(), _
	port As Integer _
)

public void Connect(
	IPAddress[] ipAddresses,
	int port
)

Visual C++

public:
void Connect(
	array<IPAddress^>^ ipAddresses, 
	int port
)

member Connect : 
        ipAddresses:IPAddress[] * 
        port:int -> unit

Parameters

ipAddresses: Type: System.Net.IPAddress[]
The IPAddress array of the host to which you intend to connect.

port: Type: System.Int32
The port number to which you intend to connect.

Exceptions

Exception	Condition
ArgumentNullException	The ipAddresses parameter is null.
ArgumentOutOfRangeException	The port number is not valid.
SocketException	An error occurred when attempting to access the socket. See the Remarks section for more information.
ObjectDisposedException	The Socket has been closed.
SecurityException	A caller higher in the call stack does not have permission for the requested operation.
NotSupportedException	This method is valid for sockets that use the InterNetwork flag or the InterNetworkV6 flag.

Remarks

This method is typically used immediately after a call to the BeginGetHostAddresses method, which can return multiple IP addresses for a single host. Call the Connect method to establish a synchronous remote host connection to the host specified by the array of IPAddress elements and the port number. The Connect method will block until it either connects or fails. After connecting with the remote host, use the GetStream method to obtain the underlying NetworkStream. Use this NetworkStream to send and receive data.

Note
If you receive a SocketException, use SocketException.ErrorCode to obtain the specific error code. After you have obtained this code, you can refer to the Windows Sockets version 2 API error code documentation in the MSDN library at http://msdn.microsoft.com/library for a detailed description of the error.

Note
This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.

Examples

The following code example uses an IP Address and port number to connect with a remote host.

Visual Basic


Private Shared Sub DoConnect(ByVal host As String, ByVal port As Integer)
    ' Connect to the specified host.
    Dim t As New TcpClient(AddressFamily.InterNetwork)

    Dim IPAddresses() As IPAddress = Dns.GetHostAddresses(host)

    Console.WriteLine("Establishing connection to {0}", host)
    t.Connect(IPAddresses, port)

    Console.WriteLine("Connection established")
End Sub


static void DoConnect(string host, int port)
{
    // Connect to the specified host.
    TcpClient t = new TcpClient(AddressFamily.InterNetwork);

    IPAddress[] IPAddresses = Dns.GetHostAddresses(host);

    Console.WriteLine("Establishing connection to {0}", host);
    t.Connect(IPAddresses, port);

    Console.WriteLine("Connection established");
}

Visual C++


static void DoConnect( String^ host, int port )
{
   // Connect to the specified host.
   TcpClient^ t = gcnew TcpClient( AddressFamily::InterNetwork );
   array<IPAddress^>^IPAddresses = Dns::GetHostAddresses( host );
   Console::WriteLine( "Establishing Connection to {0}", host );
   t->Connect( IPAddresses, port );
   Console::WriteLine( "Connection established" );
}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

TcpClient Class

Connect Overload

System.Net.Sockets Namespace

TcpListener