ClientWebSocket.ConnectAsync Methode

Definition

Namespace:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.Client.dll

Überlädt

ConnectAsync(Uri, CancellationToken)	Stellt eine Verbindung mit einem WebSocket-Server als asynchronen Vorgang her.
ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)	Stellt eine Verbindung mit einem WebSocket-Server als asynchronen Vorgang her.

ConnectAsync(Uri, CancellationToken)

Quelle:

ClientWebSocket.cs

Stellt eine Verbindung mit einem WebSocket-Server als asynchronen Vorgang her.

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

Parameter

uri

Uri

Der URI des WebSocket-Servers, mit dem eine Verbindung hergestellt werden soll.

cancellationToken

CancellationToken

Ein Abbruchtoken, das zur Weitergabe der Benachrichtigung verwendet wird, dass der Vorgang abgebrochen werden soll.

Gibt zurück

Task

Das Aufgabenobjekt, das den asynchronen Vorgang darstellt.

Ausnahmen

OperationCanceledException

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Hinweise

Die ConnectAsync -Methode initiiert den WebSocket-Handshake mit einem Remotenetzwerkziel und verhandelt dann das Unterprotokoll.

Verwenden Sie für einfache WebSocket-Verbindungen das ws:// Schema im URI. Verwenden Sie für sichere WebSocket-Verbindungen über TLS/SSL das wss:// Schema.

Dieser Vorgang wird nicht blockiert. Das zurückgegebene Task Objekt wird abgeschlossen, nachdem die Verbindungsanforderung für die ClientWebSocket instance abgeschlossen wurde.

Die WebSocket-Handshakeanforderung verfügt über Standardheader für HTTP/1.1-Anforderung:

Connection: Upgrade

Upgrade: websocket

Sec-WebSocket-Key: [generated key]

Für HTTP/2-Anforderung:

:protocol: websocket

Standardmäßig wird HTTP/1.1 verwendet. Informationen zum Ändern der verwendeten HTTP-Version oder zum Aktivieren des Upgrades/Downgrades von HTTP-Versionen finden Sie unter HttpVersion Option und HttpVersionPolicy Option.

ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)

Quelle:

ClientWebSocket.cs

Stellt eine Verbindung mit einem WebSocket-Server als asynchronen Vorgang her.

public:
 System::Threading::Tasks::Task ^ ConnectAsync(Uri ^ uri, System::Net::Http::HttpMessageInvoker ^ invoker, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task ConnectAsync (Uri uri, System.Net.Http.HttpMessageInvoker? invoker, System.Threading.CancellationToken cancellationToken);

member this.ConnectAsync : Uri * System.Net.Http.HttpMessageInvoker * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function ConnectAsync (uri As Uri, invoker As HttpMessageInvoker, cancellationToken As CancellationToken) As Task

Parameter

uri

Uri

Der URI des WebSocket-Servers, mit dem eine Verbindung hergestellt werden soll.

invoker

HttpMessageInvoker

Die HttpMessageInvoker instance, die für die Verbindung verwendet werden soll.

cancellationToken

CancellationToken

Ein Abbruchtoken, das zur Weitergabe der Benachrichtigung verwendet wird, dass der Vorgang abgebrochen werden soll.

Gibt zurück

Task

Das Aufgabenobjekt, das den asynchronen Vorgang darstellt.

Ausnahmen

OperationCanceledException

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.