AspNetWebSocket.CloseAsync Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Sendet eine asynchrone Nachricht an einen Client, um die Verbindung zu schließen. Wenn der Server die Anforderung zum Schließen der Verbindung initiiert, wartet die Methode, bis der Client die Anforderung bestätigt, bevor sie zurückgegeben wird.
public:
override System::Threading::Tasks::Task ^ CloseAsync(System::Net::WebSockets::WebSocketCloseStatus closeStatus, System::String ^ statusDescription, System::Threading::CancellationToken cancellationToken);public override System.Threading.Tasks.Task CloseAsync(System.Net.WebSockets.WebSocketCloseStatus closeStatus, string statusDescription, System.Threading.CancellationToken cancellationToken);override this.CloseAsync : System.Net.WebSockets.WebSocketCloseStatus * string * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overrides Function CloseAsync (closeStatus As WebSocketCloseStatus, statusDescription As String, cancellationToken As CancellationToken) As TaskParameter
- closeStatus
- WebSocketCloseStatus
Der Statuscode des Close-Vorgangs.
- statusDescription
- String
Die Statusmeldung des Schließensvorgangs.
- cancellationToken
- CancellationToken
Das Objekt, das einen ausstehenden Vorgang abbricht.
Gibt zurück
Ein Verweis auf den Vorgang.
Ausnahmen
Das AspNetWebSocket Objekt wurde zuvor gelöscht.
Das AspNetWebSocket Objekt befindet sich in einem abgebrochenen Zustand.
-oder-
Sendevorgänge sind nicht verfügbar.
-oder-
Empfangsvorgänge sind nicht verfügbar.
Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.
Hinweise
Sie können die Methoden und CloseAsync Methoden CloseOutputAsync sowohl für vom Client initiierte als auch für vom Server initiierte Anforderungen verwenden, um eine AspNetWebSocket Verbindung zu schließen. Die beiden Methoden behandeln clientinitiierte Anforderungen auf die gleiche Weise: Nachdem der Client eine Nachricht an den Server gesendet hat, um die Verbindung zu schließen, ruft der Server eine dieser Methoden auf und sendet eine Bestätigung an den Client, und dann wird die Methode zurückgegeben.
Bei vom Server initiierten Anforderungen funktionieren die beiden Methoden unterschiedlich. Die CloseAsync Methode sendet eine Nachricht an den Client, um die Verbindung zu schließen, wartet auf eine Antwort und gibt dann zurück. Der Server wartet nicht auf zusätzliche Daten, die vom Client gesendet werden. Im Gegensatz dazu sendet die CloseOutputAsync Methode eine Nachricht an den Client, um die Verbindung zu schließen und zurückzugeben, ohne auf eine Antwort zu warten. Nachdem die Methode zurückgegeben wurde, können Sie die ReceiveAsync Methode aufrufen und entweder zusätzliche Daten oder die Bestätigung behandeln, die der Client sendet.
