ClientWebSocket.ConnectAsync(Uri, CancellationToken) Méthode

Définition

Espace de noms:
System.Net.WebSockets
Assembly:
System.dll
Assembly:
netstandard.dll

Se connecte à un serveur WebSocket en tant qu’opération asynchrone.

public:
 System::Threading::Tasks::Task ^ ConnectAsync(Uri ^ uri, System::Threading::CancellationToken cancellationToken);
public System.Threading.Tasks.Task ConnectAsync(Uri uri, System.Threading.CancellationToken cancellationToken);
member this.ConnectAsync : Uri * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function ConnectAsync (uri As Uri, cancellationToken As CancellationToken) As Task

Paramètres

uri
Uri

URI du serveur WebSocket auquel se connecter.

cancellationToken
CancellationToken

Jeton d’annulation utilisé pour propager la notification indiquant que l’opération doit être annulée.

Retours

Task

Objet de tâche représentant l’opération asynchrone.

Exceptions

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

Remarques

La ConnectAsync méthode lance l’établissement d’une liaison WebSocket avec une destination réseau distante, puis négocie le sous-protocole.

Pour les connexions WebSocket simples, utilisez le ws:// schéma dans l’URI. Pour sécuriser les connexions WebSocket sur TLS/SSL, utilisez le wss:// schéma.

Cette opération ne bloque pas. L’objet retourné Task se termine une fois la demande de connexion effectuée sur l’instance ClientWebSocket .

La requête de négociation WebSocket a des en-têtes par défaut pour la requête HTTP/1.1 :

Connection: Upgrade

Upgrade: websocket

Sec-WebSocket-Key: [generated key]

Pour la requête HTTP/2 :

:protocol: websocket

Par défaut, HTTP/1.1 sera utilisé. Pour modifier la version HTTP utilisée ou activer la mise à niveau/rétrogradation de version HTTP, consultez HttpVersion l’option et HttpVersionPolicy l’option.

S’applique à