System.Net.Sockets.TcpClient.ConnectAsync Method

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

Syntax

public System.Threading.Tasks.Task ConnectAsync (System.Net.IPAddress[] addresses, int port)

Parameters

addresses
The System.Net.IPAddress array of the host to which you intend to connect.
port
The port number to which you intend to connect.

Returns

Returns System.Threading.Tasks.Task

The task object representing the asynchronous operation.

Remarks

This operation will not block. The returned Returns System.Threading.Tasks.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 System.Net.Dns.BeginGetHostAddresses(string, AsyncCallback, object) 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 System.Net.IPAddress elements and the port number as an asynchronous operation. After connecting with the remote host, use the TcpClient.GetStream method to obtain the underlying System.Net.Sockets.NetworkStream. Use this System.Net.Sockets.NetworkStream to send and receive data.

Note:

If you receive a System.Net.Sockets.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 tp://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 [<topic://conUsingNetworkTracing>].

Requirements

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