AspNetWebSocket.CloseAsync Metoda

Definice

Obor názvů:

System.Web.WebSockets

Sestavení:

System.Web.dll

Odešle asynchronní zprávu klientovi o ukončení připojení. Pokud server iniciuje požadavek na ukončení připojení, metoda čeká, než klient potvrdí požadavek, než se vrátí.

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

Parametry

closeStatus

WebSocketCloseStatus

Stavový kód operace zavření.

statusDescription

String

Stavová zpráva operace zavření.

cancellationToken

CancellationToken

Objekt, který zruší čekající operaci.

Návraty

Task

Odkaz na operaci.

Výjimky

ObjectDisposedException

Objekt AspNetWebSocket byl dříve odstraněn.

InvalidOperationException

Objekt AspNetWebSocket je v přerušeném stavu.

-nebo-

Operace odesílání nejsou k dispozici.

-nebo-

Operace příjmu nejsou k dispozici.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka se uloží do vrácené úlohy.

Poznámky

K ukončení připojení můžete použít CloseAsync metody a CloseOutputAsync pro požadavky iniciované klientem i serverem AspNetWebSocket . Dvě metody zpracovávají požadavky iniciované klientem stejným způsobem: Poté, co klient odešle zprávu na server o ukončení připojení, server zavolá jednu z těchto metod, odešle klientovi potvrzení a pak metoda vrátí.

U požadavků iniciovaných serverem fungují tyto dvě metody odlišně. Metoda CloseAsync odešle klientovi zprávu o ukončení připojení, počká na odpověď a pak ji vrátí. Server nečeká na žádná další data odeslaná klientem. Naproti tomu CloseOutputAsync metoda odešle klientovi zprávu o ukončení připojení a vrátí se bez čekání na odpověď. Po vrácení metody můžete volat metodu ReceiveAsync a zpracovat buď další data, nebo potvrzení, které klient odešle.