ClientWebSocket.CloseAsync Metoda

Definicja

Przestrzeń nazw:

System.Net.WebSockets

Zestaw:

System.Net.WebSockets.Client.dll

Źródło:

ClientWebSocket.cs

ClientWebSocket Zamknij wystąpienie jako operację asynchroniczną.

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

Stan zamknięcia protokołu WebSocket.

statusDescription

String

Opis stanu zamknięcia.

cancellationToken

CancellationToken

Token odwołania, wykorzystywany do propagowania powiadomienia, że niniejsza operacja powinna zostać anulowana.

Zwraca

Task

Obiekt zadania reprezentujący operację asynchroniczną.

Wyjątki

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwróconym zadaniu.

Uwagi

Ta operacja nie będzie blokować. Zwrócony obiekt zostanie ukończony Task po ClientWebSocket zamknięciu wystąpienia.