ConnectAsync Method (IPAddress, Int32)
Collapse the table of content
Expand the table of content

TcpClient.ConnectAsync Method (IPAddress, Int32)

.NET Framework (current version)
 

Connects the client to a remote TCP host using the specified IP address 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 address,
	int port
)

Parameters

address
Type: System.Net.IPAddress

The IPAddress 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 address parameter is null.

ArgumentOutOfRangeException

The port 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 IPAddress 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.

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:
© 2016 Microsoft