SocketTaskExtensions.ConnectAsync Method

Definition

Overloads

ConnectAsync(Socket, IPAddress[], Int32, CancellationToken)

Establishes a connection to a remote host, which is specified by an array of IP addresses and a port number.

ConnectAsync(Socket, IPAddress, Int32, CancellationToken)

Establishes a connection to a remote host, which is specified by an IP address and a port number.

ConnectAsync(Socket, String, Int32)

Establishes a connection to a remote host. The host is specified by a host name and a port number.

ConnectAsync(Socket, String, Int32, CancellationToken)

Establishes a connection to a remote host, which is specified by a host name and a port number.

ConnectAsync(Socket, IPAddress, Int32)

Establishes a connection to a remote host. The host is specified by an IP address and a port number.

ConnectAsync(Socket, EndPoint, CancellationToken)

Establishes a connection to a remote host.

ConnectAsync(Socket, EndPoint)

Establishes a connection to a remote host.

ConnectAsync(Socket, IPAddress[], Int32)

Establishes a connection to a remote host. The host is specified by an array of IP addresses and a port number.

ConnectAsync(Socket, IPAddress[], Int32, CancellationToken)

Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs

Establishes a connection to a remote host, which is specified by an array of IP addresses and a port number.

public static System.Threading.Tasks.ValueTask ConnectAsync (this System.Net.Sockets.Socket socket, System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken);

Parameters

socket
Socket

The socket that the connect operation is performed on.

addresses
IPAddress[]

The IP addresses of the remote host.

port
Int32

The port number of the remote host.

cancellationToken
CancellationToken

A cancellation token that can be used to signal the asynchronous operation should be canceled.

Returns

A task that represents the asynchronous connection operation.

Exceptions

The addresses parameter cannot be null.

The addresses parameter cannot be empty array.

port is less than MinPort.

-or-

port is greater than MaxPort.

The Socket is listening.

An error occurred when attempting to access the socket.

The Socket has been closed.

A caller higher in the call stack does not have permission for the requested operation.

The cancellation token was canceled. This exception is stored into the returned task.

Applies to

.NET 9 and other versions
Product Versions
.NET 5, 6, 7, 8, 9

ConnectAsync(Socket, IPAddress, Int32, CancellationToken)

Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs

Establishes a connection to a remote host, which is specified by an IP address and a port number.

public static System.Threading.Tasks.ValueTask ConnectAsync (this System.Net.Sockets.Socket socket, System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken);

Parameters

socket
Socket

The socket to perform the connect operation on.

address
IPAddress

The IP address of the remote host.

port
Int32

The port number of the remote host.

cancellationToken
CancellationToken

A cancellation token that can be used to signal the asynchronous operation should be canceled.

Returns

A task that represents the asynchronous connection operation.

Exceptions

The address parameter cannot be null.

port is less than MinPort.

-or-

port is greater than MaxPort.

The Socket is listening.

An error occurred when attempting to access the socket.

The Socket has been closed.

A caller higher in the call stack does not have permission for the requested operation.

The cancellation token was canceled. This exception is stored into the returned task.

Applies to

.NET 9 and other versions
Product Versions
.NET 5, 6, 7, 8, 9

ConnectAsync(Socket, String, Int32)

Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs

Establishes a connection to a remote host. The host is specified by a host name and a port number.

public static System.Threading.Tasks.Task ConnectAsync (this System.Net.Sockets.Socket socket, string host, int port);

Parameters

socket
Socket

The socket to perform the connect operation on.

host
String

The name of the remote host.

port
Int32

The port number of the remote host.

Returns

An asynchronous task.

Exceptions

The host parameter cannot be null.

port is less than MinPort.

-or-

port is greater than MaxPort.

The Socket is listening.

An error occurred when attempting to access the socket.

The Socket has been closed.

A caller higher in the call stack does not have permission for the requested operation.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1

ConnectAsync(Socket, String, Int32, CancellationToken)

Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs

Establishes a connection to a remote host, which is specified by a host name and a port number.

public static System.Threading.Tasks.ValueTask ConnectAsync (this System.Net.Sockets.Socket socket, string host, int port, System.Threading.CancellationToken cancellationToken);

Parameters

socket
Socket

The socket to perform the connect operation on.

host
String

The name of the remote host.

port
Int32

The port number of the remote host.

cancellationToken
CancellationToken

A cancellation token that can be used to signal the asynchronous operation should be canceled.

Returns

A task that represents an asynchronous connection operation.

Exceptions

The host parameter cannot be null.

port is less than MinPort.

-or-

port is greater than MaxPort.

The Socket is listening.

An error occurred when attempting to access the socket.

The Socket has been closed.

A caller higher in the call stack does not have permission for the requested operation.

The cancellation token was canceled. This exception is stored into the returned task.

Applies to

.NET 9 and other versions
Product Versions
.NET 5, 6, 7, 8, 9

ConnectAsync(Socket, IPAddress, Int32)

Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs

Establishes a connection to a remote host. The host is specified by an IP address and a port number.

public static System.Threading.Tasks.Task ConnectAsync (this System.Net.Sockets.Socket socket, System.Net.IPAddress address, int port);

Parameters

socket
Socket

The socket to perform the connect operation on.

address
IPAddress

The IP address of the remote host.

port
Int32

The port number of the remote host.

Returns

A task that represents an asynchronous connection operation.

Exceptions

The address parameter cannot be null.

port is less than MinPort.

-or-

port is greater than MaxPort.

The Socket is listening.

An error occurred when attempting to access the socket.

The Socket has been closed.

A caller higher in the call stack does not have permission for the requested operation.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1

ConnectAsync(Socket, EndPoint, CancellationToken)

Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs

Establishes a connection to a remote host.

public static System.Threading.Tasks.ValueTask ConnectAsync (this System.Net.Sockets.Socket socket, System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken);

Parameters

socket
Socket

The socket that is used for establishing a connection.

remoteEP
EndPoint

An EndPoint that represents the remote device.

cancellationToken
CancellationToken

A cancellation token that can be used to signal the asynchronous operation should be canceled.

Returns

A task that represents the asynchronous connection operation.

Exceptions

The remoteEP parameter cannot be null.

The Socket is listening.

An error occurred when attempting to access the socket.

The local endpoint and the remoteEP parameter are not the same address family.

The Socket has been closed.

A caller higher in the call stack does not have permission for the requested operation.

The cancellation token was canceled. This exception is stored into the returned task.

Applies to

.NET 9 and other versions
Product Versions
.NET 5, 6, 7, 8, 9

ConnectAsync(Socket, EndPoint)

Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs

Establishes a connection to a remote host.

public static System.Threading.Tasks.Task ConnectAsync (this System.Net.Sockets.Socket socket, System.Net.EndPoint remoteEP);

Parameters

socket
Socket

The socket that is used for establishing a connection.

remoteEP
EndPoint

An EndPoint that represents the remote device.

Returns

An asynchronous Task.

Exceptions

The remoteEP parameter cannot be null.

The Socket is listening.

An error occurred when attempting to access the socket.

The local endpoint and the remoteEP parameter are not the same address family.

The Socket has been closed.

A caller higher in the call stack does not have permission for the requested operation.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1

ConnectAsync(Socket, IPAddress[], Int32)

Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs
Source:
SocketTaskExtensions.cs

Establishes a connection to a remote host. The host is specified by an array of IP addresses and a port number.

public static System.Threading.Tasks.Task ConnectAsync (this System.Net.Sockets.Socket socket, System.Net.IPAddress[] addresses, int port);

Parameters

socket
Socket

The socket that the connect operation is performed on.

addresses
IPAddress[]

The IP addresses of the remote host.

port
Int32

The port number of the remote host.

Returns

A task that represents the asynchronous connect operation.

Exceptions

The addresses parameter cannot be null.

The addresses parameter cannot be empty array.

port is less than MinPort.

-or-

port is greater than MaxPort.

The Socket is listening.

An error occurred when attempting to access the socket.

The Socket has been closed.

A caller higher in the call stack does not have permission for the requested operation.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1