SocketTaskExtensions.ConnectAsync Method

Definition

Namespace:

System.Net.Sockets

Assembly:

System.Net.Sockets.dll

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

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

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::ValueTask ConnectAsync(System::Net::Sockets::Socket ^ socket, cli::array <System::Net::IPAddress ^> ^ addresses, int port, System::Threading::CancellationToken cancellationToken);

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

static member ConnectAsync : System.Net.Sockets.Socket * System.Net.IPAddress[] * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

<Extension()>
Public Function ConnectAsync (socket As Socket, addresses As IPAddress(), port As Integer, cancellationToken As CancellationToken) As ValueTask

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

ValueTask

A task that represents the asynchronous connection operation.

Exceptions

ArgumentNullException

The addresses parameter cannot be null.

ArgumentException

The addresses parameter cannot be empty array.

ArgumentOutOfRangeException

port is less than MinPort.

-or-

port is greater than MaxPort.

InvalidOperationException

The Socket is listening.

SocketException

An error occurred when attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

SecurityException

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

OperationCanceledException

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

ConnectAsync(Socket, IPAddress, Int32, CancellationToken)

Source:

SocketTaskExtensions.cs

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

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::ValueTask ConnectAsync(System::Net::Sockets::Socket ^ socket, System::Net::IPAddress ^ address, int port, System::Threading::CancellationToken cancellationToken);

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

static member ConnectAsync : System.Net.Sockets.Socket * System.Net.IPAddress * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

<Extension()>
Public Function ConnectAsync (socket As Socket, address As IPAddress, port As Integer, cancellationToken As CancellationToken) As ValueTask

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

ValueTask

A task that represents the asynchronous connection operation.

Exceptions

ArgumentNullException

The address parameter cannot be null.

ArgumentOutOfRangeException

port is less than MinPort.

-or-

port is greater than MaxPort.

InvalidOperationException

The Socket is listening.

SocketException

An error occurred when attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

SecurityException

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

OperationCanceledException

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

ConnectAsync(Socket, String, Int32)

Source:

SocketTaskExtensions.cs

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

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ ConnectAsync(System::Net::Sockets::Socket ^ socket, System::String ^ host, int port);

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

static member ConnectAsync : System.Net.Sockets.Socket * string * int -> System.Threading.Tasks.Task

<Extension()>
Public Function ConnectAsync (socket As Socket, host As String, port As Integer) As Task

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

Task

An asynchronous task.

Exceptions

ArgumentNullException

The host parameter cannot be null.

ArgumentOutOfRangeException

port is less than MinPort.

-or-

port is greater than MaxPort.

InvalidOperationException

The Socket is listening.

SocketException

An error occurred when attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

SecurityException

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

ConnectAsync(Socket, String, Int32, CancellationToken)

Source:

SocketTaskExtensions.cs

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

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::ValueTask ConnectAsync(System::Net::Sockets::Socket ^ socket, System::String ^ host, int port, System::Threading::CancellationToken cancellationToken);

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

static member ConnectAsync : System.Net.Sockets.Socket * string * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

<Extension()>
Public Function ConnectAsync (socket As Socket, host As String, port As Integer, cancellationToken As CancellationToken) As ValueTask

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

ValueTask

A task that represents an asynchronous connection operation.

Exceptions

ArgumentNullException

The host parameter cannot be null.

ArgumentOutOfRangeException

port is less than MinPort.

-or-

port is greater than MaxPort.

InvalidOperationException

The Socket is listening.

SocketException

An error occurred when attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

SecurityException

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

OperationCanceledException

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

ConnectAsync(Socket, IPAddress, Int32)

Source:

SocketTaskExtensions.cs

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

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ ConnectAsync(System::Net::Sockets::Socket ^ socket, System::Net::IPAddress ^ address, int port);

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

static member ConnectAsync : System.Net.Sockets.Socket * System.Net.IPAddress * int -> System.Threading.Tasks.Task

<Extension()>
Public Function ConnectAsync (socket As Socket, address As IPAddress, port As Integer) As Task

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

Task

A task that represents an asynchronous connection operation.

Exceptions

ArgumentNullException

The address parameter cannot be null.

ArgumentOutOfRangeException

port is less than MinPort.

-or-

port is greater than MaxPort.

InvalidOperationException

The Socket is listening.

SocketException

An error occurred when attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

SecurityException

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

ConnectAsync(Socket, EndPoint, CancellationToken)

Source:

SocketTaskExtensions.cs

Establishes a connection to a remote host.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::ValueTask ConnectAsync(System::Net::Sockets::Socket ^ socket, System::Net::EndPoint ^ remoteEP, System::Threading::CancellationToken cancellationToken);

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

static member ConnectAsync : System.Net.Sockets.Socket * System.Net.EndPoint * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

<Extension()>
Public Function ConnectAsync (socket As Socket, remoteEP As EndPoint, cancellationToken As CancellationToken) As ValueTask

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

ValueTask

A task that represents the asynchronous connection operation.

Exceptions

ArgumentNullException

The remoteEP parameter cannot be null.

InvalidOperationException

The Socket is listening.

SocketException

An error occurred when attempting to access the socket.

NotSupportedException

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

ObjectDisposedException

The Socket has been closed.

SecurityException

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

OperationCanceledException

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

ConnectAsync(Socket, EndPoint)

Source:

SocketTaskExtensions.cs

Establishes a connection to a remote host.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ ConnectAsync(System::Net::Sockets::Socket ^ socket, System::Net::EndPoint ^ remoteEP);

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

static member ConnectAsync : System.Net.Sockets.Socket * System.Net.EndPoint -> System.Threading.Tasks.Task

<Extension()>
Public Function ConnectAsync (socket As Socket, remoteEP As EndPoint) As Task

Parameters

socket

Socket

The socket that is used for establishing a connection.

remoteEP

EndPoint

An EndPoint that represents the remote device.

Returns

Task

An asynchronous Task.

Exceptions

ArgumentNullException

The remoteEP parameter cannot be null.

InvalidOperationException

The Socket is listening.

SocketException

An error occurred when attempting to access the socket.

NotSupportedException

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

ObjectDisposedException

The Socket has been closed.

SecurityException

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

ConnectAsync(Socket, IPAddress[], Int32)

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:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ ConnectAsync(System::Net::Sockets::Socket ^ socket, cli::array <System::Net::IPAddress ^> ^ addresses, int port);

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

static member ConnectAsync : System.Net.Sockets.Socket * System.Net.IPAddress[] * int -> System.Threading.Tasks.Task

<Extension()>
Public Function ConnectAsync (socket As Socket, addresses As IPAddress(), port As Integer) As Task

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

Task

A task that represents the asynchronous connect operation.

Exceptions

ArgumentNullException

The addresses parameter cannot be null.

ArgumentException

The addresses parameter cannot be empty array.

ArgumentOutOfRangeException

port is less than MinPort.

-or-

port is greater than MaxPort.

InvalidOperationException

The Socket is listening.

SocketException

An error occurred when attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

SecurityException

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