WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) Methode

Definition

Namespace:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.dll

Quelle:

WebSocket.cs

Schließt die WebSocket-Verbindung unter Verwendung des in Abschnitt 7 der WebSocket-Protokollspezifikation definierten Schließen-Handshakes in einem asynchronen Vorgang.

public:
 abstract System::Threading::Tasks::Task ^ CloseAsync(System::Net::WebSockets::WebSocketCloseStatus closeStatus, System::String ^ statusDescription, System::Threading::CancellationToken cancellationToken);

public abstract System.Threading.Tasks.Task CloseAsync (System.Net.WebSockets.WebSocketCloseStatus closeStatus, string? statusDescription, System.Threading.CancellationToken cancellationToken);

abstract member CloseAsync : System.Net.WebSockets.WebSocketCloseStatus * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public MustOverride Function CloseAsync (closeStatus As WebSocketCloseStatus, statusDescription As String, cancellationToken As CancellationToken) As Task

Parameter

closeStatus

WebSocketCloseStatus

Gibt den Grund für das Schließen der WebSocket-Verbindung an.

statusDescription

String

Stellt eine lesbare Begründung für das Schließen der Verbindung bereit.

cancellationToken

CancellationToken

Das Token, mit dem die Benachrichtigung verteilt werden kann, dass Vorgänge abgebrochen werden sollen.

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

Dieser Vorgang wird nicht blockiert. Das zurückgegebene Task Objekt wird abgeschlossen, nachdem das WebSocket geschlossen wurde.

Diese Methode schließt die WebSocket-Verbindung mithilfe des im Abschnitt 7 der WebSocket-Protokollspezifikation definierten close-Handshake.