TcpClient.ConnectAsync Method (IPAddress[], Int32)

.NET Framework (current version)
 

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

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

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public Task ConnectAsync(
	IPAddress[] addresses,
	int port
)

Parameters

addresses
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.

Return Value

Type: System.Threading.Tasks.Task

Returns Task

The task object representing the asynchronous operation.

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.

This operation will not block. The returned Returns Task object will complete after the TCP connection has been established. This method does not block the calling thread while the connection request is underway.

This method is typically used immediately after a call to the BeginGetHostAddresses method, which can return multiple IP addresses for a single host. Call this method to establish a synchronous remote host connection to the host specified by the array of IPAddress elements and the port number as an asynchronous operation. After connecting with the remote host, use the GetStream method to obtain the underlying NetworkStream. Use this NetworkStream to send and receive data.

System_CAPS_noteNote

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.

System_CAPS_noteNote

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

.NET Framework
Available since 4.5
Return to top
Show: