WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) Methode

Definition

Namespace:
System.Net.WebSockets
Assemblys:
netstandard.dll, System.Net.WebSockets.dll
Assembly:
System.Net.WebSockets.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Quelle:
WebSocket.cs
Quelle:
WebSocket.cs
Quelle:
WebSocket.cs
Quelle:
WebSocket.cs
Quelle:
WebSocket.cs

Schließt die WebSocket-Verbindung als asynchronen Vorgang mithilfe des in der WebSocket-Protokollspezifikation definierten Schließen-Handshakes, Abschnitt 7.

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);
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

Gibt eine lesbare Erklärung an, warum die Verbindung geschlossen wird.

cancellationToken
CancellationToken

Das Token, das zum Verteilen der Benachrichtigung verwendet 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.

Mit dieser Methode wird die WebSocket-Verbindung mit dem schließende Handshake geschlossen, der in der WebSocket-Protokollspezifikation, Abschnitt 7, definiert ist.

Gilt für: