TcpClient::ConnectAsync Method (String^, Int32)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Connects the client to the specified TCP port on the specified host as an asynchronous operation.

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

public:
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
Task^ ConnectAsync(
	String^ host,
	int port
)

Parameters

host
Type: System::String^

The DNS name of the remote host to which you intend to connect.

port
Type: System::Int32

The port number of the remote host 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 hostname parameter is null.

ArgumentOutOfRangeException

The port parameter is not between MinPort and MaxPort.

SocketException

An error occurred when accessing the socket. See the Remarks section for more information.

ObjectDisposedException

TcpClient is closed.

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.

Call this method to establish a synchronous remote host connection to the specified host name and 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.

If IPv6 is enabled and the ConnectAsync(String^, Int32) method is called to connect to a host that resolves to both IPv6 and IPv4 addresses, the connection to the IPv6 address will be attempted first before the IPv4 address. This may have the effect of delaying the time to establish the connection if the host is not listening on the IPv6 address.

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 MSDN 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: