WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) Metoda

Definice

Obor názvů:

System.Net.WebSockets

Sestavení:

System.Net.WebSockets.dll

Zdroj:

WebSocket.cs

Zavře připojení WebSocket jako asynchronní operaci pomocí metody handshake definované v části 7 specifikace protokolu WebSocket .

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

Parametry

closeStatus

WebSocketCloseStatus

Označuje důvod ukončení připojení WebSocket.

statusDescription

String

Určuje čitelné vysvětlení, proč je připojení uzavřeno.

cancellationToken

CancellationToken

Token, který lze použít k šíření oznámení, že operace by měly být zrušeny.

Návraty

Task

Objekt úlohy představující asynchronní operaci.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Tato operace nebude blokována. Task Vrácený objekt se dokončí po zavření protokolu WebSocket.

Tato metoda zavře připojení WebSocket pomocí metody handshake definované ve specifikaci protokolu WebSocket oddíl 7.