Socket.ConnectAsync Méthode

Source:

Socket.cs

Source:

Socket.cs

Source:

Socket.cs

public:
 static bool ConnectAsync(System::Net::Sockets::SocketType socketType, System::Net::Sockets::ProtocolType protocolType, System::Net::Sockets::SocketAsyncEventArgs ^ e);

public static bool ConnectAsync (System.Net.Sockets.SocketType socketType, System.Net.Sockets.ProtocolType protocolType, System.Net.Sockets.SocketAsyncEventArgs e);

static member ConnectAsync : System.Net.Sockets.SocketType * System.Net.Sockets.ProtocolType * System.Net.Sockets.SocketAsyncEventArgs -> bool

Public Shared Function ConnectAsync (socketType As SocketType, protocolType As ProtocolType, e As SocketAsyncEventArgs) As Boolean

Paramètres

Retours

true si l’opération d’E/S est en attente. L'événement Completed sur le paramètre e sera déclenché une fois l'opération terminée.

false si l’opération d’E/S a été terminée de manière synchrone. Dans ce cas, l'événement Completed sur le paramètre e ne sera pas déclenché et l'objet e transmis en tant que paramètre peut être examiné immédiatement après que l'appel de méthode a été retourné pour extraire le résultat de l'opération.

Exceptions

Remarques

Si vous utilisez un protocole orienté connexion, la méthode M :System.Net.Sockets.Sockets.ConnectAsync(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.Net.Sockets.Sockets.SocketS.SocketS.SocketAsyncEventArgs) démarre une demande asynchrone pour une connexion à l’hôte distant. Si vous utilisez un protocole sans connexion, ConnectAsync établit un hôte distant par défaut spécifié par les socketType paramètres et protocolType .

Pour être averti de l’achèvement, vous devez créer une méthode de rappel qui implémente le délégué EventHandler<SocketAsyncEventArgs> et attacher le rappel à l’événement SocketAsyncEventArgs.Completed .

L’appelant doit définir la propriété sur SocketAsyncEventArgs.RemoteEndPoint le IPEndPoint de l’hôte distant auquel se connecter.

L’appelant peut définir la SocketAsyncEventArgs.UserToken propriété sur n’importe quel objet d’état utilisateur souhaité avant d’appeler la ConnectAsync méthode, afin que les informations soient récupérables dans la méthode de rappel. Si le rappel a besoin de plus d’informations qu’un seul objet, une petite classe peut être créée pour contenir les autres informations d’état requises en tant que membres.

Si vous utilisez un protocole sans connexion tel qu’UDP, vous n’avez pas besoin d’appeler ConnectAsync avant d’envoyer et de recevoir des données. Vous pouvez utiliser SendToAsync et ReceiveFromAsync pour communiquer avec un hôte distant. Si vous appelez ConnectAsync, tous les datagrammes qui arrivent d’une adresse autre que la valeur par défaut spécifiée seront ignorés. Si vous souhaitez modifier l’hôte distant par défaut, appelez à nouveau la ConnectAsync méthode avec le point de terminaison souhaité.

Si vous souhaitez définir l’hôte distant par défaut sur une adresse de diffusion, vous devez d’abord appeler SetSocketOption et définir Broadcast sur true. Si cette opération n’est pas effectuée, la ConnectAsync méthode lève un SocketException.

Les propriétés et événements suivants sur l’objet System.Net.Sockets.SocketAsyncEventArgs sont requis :

• SocketAsyncEventArgs.Completed

• SocketAsyncEventArgs.RemoteEndPoint

Éventuellement, une mémoire tampon peut être fournie qui sera envoyée de manière atomique sur le socket une fois la ConnectAsync méthode réussie. Dans ce cas, la SocketAsyncEventArgs.Buffer propriété doit être définie sur la mémoire tampon contenant les données à envoyer et la SocketAsyncEventArgs.Count propriété doit être définie sur le nombre d’octets de données à envoyer à partir de la mémoire tampon. Une fois la connexion établie, cette mémoire tampon de données est envoyée.

Si vous utilisez un protocole orienté connexion et que vous n’appelez Bind pas avant d’appeler ConnectAsync, le fournisseur de services sous-jacent attribuera l’adresse de réseau local et le numéro de port les plus appropriés.

Si vous utilisez un protocole sans connexion, le fournisseur de services n’affectera pas d’adresse IP de réseau local et de numéro de port tant que vous n’appelez pas les SendAsync méthodes ou ReceiveAsync .

La ConnectAsync méthode lève NotSupportedException si la famille d’adresses du Socket et les SocketAsyncEventArgs.RemoteEndPoint ne sont pas la même famille d’adresses.

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::ValueTask ConnectAsync(cli::array <System::Net::IPAddress ^> ^ addresses, int port, System::Threading::CancellationToken cancellationToken);

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

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

Public Function ConnectAsync (addresses As IPAddress(), port As Integer, cancellationToken As CancellationToken) As ValueTask

Paramètres

Retours

Tâche asynchrone qui se termine lorsque la connexion est établie.

Exceptions

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par Connect(IPAddress[], Int32).

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::ValueTask ConnectAsync(System::String ^ host, int port, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.ValueTask ConnectAsync (string host, int port, System.Threading.CancellationToken cancellationToken);

member this.ConnectAsync : string * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function ConnectAsync (host As String, port As Integer, cancellationToken As CancellationToken) As ValueTask

Paramètres

Retours

Tâche asynchrone qui se termine lorsque la connexion est établie.

Exceptions

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par Connect(String, Int32).

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::ValueTask ConnectAsync(System::Net::IPAddress ^ address, int port, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.ValueTask ConnectAsync (System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken);

member this.ConnectAsync : System.Net.IPAddress * int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function ConnectAsync (address As IPAddress, port As Integer, cancellationToken As CancellationToken) As ValueTask

Paramètres

Retours

Tâche asynchrone qui se termine lorsque la connexion est établie.

Exceptions

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par Connect(IPAddress, Int32).

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task ^ ConnectAsync(System::String ^ host, int port);

public System.Threading.Tasks.Task ConnectAsync (string host, int port);

member this.ConnectAsync : string * int -> System.Threading.Tasks.Task

Public Function ConnectAsync (host As String, port As Integer) As Task

Paramètres

Retours

Tâche asynchrone qui se termine lorsque la connexion est établie.

Exceptions

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par Connect(String, Int32).

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task ^ ConnectAsync(cli::array <System::Net::IPAddress ^> ^ addresses, int port);

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

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

Public Function ConnectAsync (addresses As IPAddress(), port As Integer) As Task

Paramètres

Retours

Tâche asynchrone qui se termine lorsque la connexion est établie.

Exceptions

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par Connect(IPAddress[], Int32).

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task ^ ConnectAsync(System::Net::IPAddress ^ address, int port);

public System.Threading.Tasks.Task ConnectAsync (System.Net.IPAddress address, int port);

member this.ConnectAsync : System.Net.IPAddress * int -> System.Threading.Tasks.Task

Public Function ConnectAsync (address As IPAddress, port As Integer) As Task

Paramètres

Retours

Tâche asynchrone qui se termine lorsque la connexion est établie.

Exceptions

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par Connect(IPAddress, Int32).

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::ValueTask ConnectAsync(System::Net::EndPoint ^ remoteEP, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.ValueTask ConnectAsync (System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken);

member this.ConnectAsync : System.Net.EndPoint * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function ConnectAsync (remoteEP As EndPoint, cancellationToken As CancellationToken) As ValueTask

Paramètres

Retours

Tâche asynchrone qui se termine lorsque la connexion est établie.

Exceptions

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par Connect(EndPoint).

Source:

Socket.cs

Source:

Socket.cs

Source:

Socket.cs

public:
 bool ConnectAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);

public bool ConnectAsync (System.Net.Sockets.SocketAsyncEventArgs e);

member this.ConnectAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool

Public Function ConnectAsync (e As SocketAsyncEventArgs) As Boolean

Paramètres

Retours

true si l’opération d’E/S est en attente. L'événement Completed sur le paramètre e sera déclenché une fois l'opération terminée.

false si l’opération d’E/S a été terminée de manière synchrone. Dans ce cas, l'événement Completed sur le paramètre e ne sera pas déclenché et l'objet e transmis en tant que paramètre peut être examiné immédiatement après que l'appel de méthode a été retourné pour extraire le résultat de l'opération.

Exceptions

Remarques

Si vous utilisez un protocole orienté connexion, la ConnectAsync méthode démarre une demande asynchrone pour une connexion à l’hôte distant. Si vous utilisez un protocole sans connexion, ConnectAsync établit un hôte distant par défaut.

Pour être averti de l’achèvement, vous devez créer une méthode de rappel qui implémente le délégué EventHandler<SocketAsyncEventArgs> et attacher le rappel à l’événement SocketAsyncEventArgs.Completed .

L’appelant doit définir la propriété sur SocketAsyncEventArgs.RemoteEndPoint le IPEndPoint de l’hôte distant auquel se connecter.

L’appelant peut définir la SocketAsyncEventArgs.UserToken propriété sur n’importe quel objet d’état utilisateur souhaité avant d’appeler la ConnectAsync méthode, afin que les informations soient récupérables dans la méthode de rappel. Si le rappel a besoin de plus d’informations qu’un seul objet, une petite classe peut être créée pour contenir les autres informations d’état requises en tant que membres.

Si vous utilisez un protocole sans connexion tel qu’UDP, vous n’avez pas besoin d’appeler ConnectAsync avant d’envoyer et de recevoir des données. Vous pouvez utiliser SendToAsync et ReceiveFromAsync pour communiquer avec un hôte distant. Si vous appelez ConnectAsync, tous les datagrammes qui arrivent d’une adresse autre que la valeur par défaut spécifiée seront ignorés. Si vous souhaitez modifier l’hôte distant par défaut, appelez à nouveau la ConnectAsync méthode avec le point de terminaison souhaité.

Si vous souhaitez définir l’hôte distant par défaut sur une adresse de diffusion, vous devez d’abord appeler SetSocketOption et définir Diffusion sur true. Si ce n’est pas le cas, la ConnectAsync méthode lève un SocketException.

Les propriétés et événements suivants sur l’objet System.Net.Sockets.SocketAsyncEventArgs sont requis :

• SocketAsyncEventArgs.Completed

• SocketAsyncEventArgs.RemoteEndPoint

Si vous le souhaitez, une mémoire tampon peut être fournie, qui sera envoyée atomiquement sur le socket une fois la ConnectAsync méthode réussie. Dans ce cas, la SocketAsyncEventArgs.Buffer propriété doit être définie sur la mémoire tampon contenant les données à envoyer et la SocketAsyncEventArgs.Count propriété doit être définie sur le nombre d’octets de données à envoyer à partir de la mémoire tampon. Une fois qu’une connexion est établie, cette mémoire tampon de données est envoyée.

Si vous utilisez un protocole orienté connexion et que vous n’appelez Bind pas avant d’appeler ConnectAsync, le fournisseur de services sous-jacent attribue l’adresse réseau locale et le numéro de port les plus appropriés.

Si vous utilisez un protocole sans connexion, le fournisseur de services n’affectera pas d’adresse IP de réseau local et de numéro de port tant que vous n’appelez pas les SendAsync méthodes ou ReceiveAsync .

La ConnectAsync méthode lève NotSupportedException si la famille d’adresses du Socket et le SocketAsyncEventArgs.RemoteEndPoint ne sont pas la même famille d’adresses.

Voir aussi

• SocketAsyncEventArgs
• Buffer
• Completed
• Count
• RemoteEndPoint
• UserToken

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task ^ ConnectAsync(System::Net::EndPoint ^ remoteEP);

public System.Threading.Tasks.Task ConnectAsync (System.Net.EndPoint remoteEP);

member this.ConnectAsync : System.Net.EndPoint -> System.Threading.Tasks.Task

Public Function ConnectAsync (remoteEP As EndPoint) As Task

Paramètres

Retours

Tâche asynchrone qui se termine lorsque la connexion est établie.

Exceptions

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que le équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour les exceptions stockées, consultez les exceptions levées par Connect(EndPoint).