Freigeben über


AspNetWebSocket.CloseAsync Methode

Definition

Sendet eine asynchrone Meldung an einen Client, um die Verbindung zu schließen. Wenn der Server die Anforderung initiiert, um die Verbindung zu schließen, wartet die Methode darauf, dass der Client die Anforderung bestätigt, bevor eine Rückgabe erfolgt.

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.Task
Public Overrides Function CloseAsync (closeStatus As WebSocketCloseStatus, statusDescription As String, cancellationToken As CancellationToken) As Task

Parameter

closeStatus
WebSocketCloseStatus

Der Statuscode des Schließen-Vorgangs.

statusDescription
String

Die Statusmeldung des Schließvorgangs.

cancellationToken
CancellationToken

Das Objekt, das einen ausstehenden Vorgang abbricht.

Gibt zurück

Ein Verweis auf den Vorgang.

Ausnahmen

Das AspNetWebSocket-Objekt war zuvor freigegeben.

Das AspNetWebSocket -Objekt weist einen Abbruchstatus auf.

- oder -

Senden von Vorgängen, die nicht verfügbar sind.

- oder -

Empfangen von Vorgängen nicht verfügbar.

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

Hinweise

Sie können die CloseAsync Methoden und CloseOutputAsync sowohl für clientinitiierte als auch für serverinitiierte Anforderungen verwenden, um eine AspNetWebSocket Verbindung zu schließen. Die beiden Methoden behandeln vom Client initiierte 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 die Methode gibt dann zurück.

Bei serverinitiierte 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 gibt zurück, 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 Vom Client gesendete Bestätigung verarbeiten.

Gilt für: