WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) Metoda

Definicja

Przestrzeń nazw:

System.Net.WebSockets

Zestaw:

System.Net.WebSockets.dll

Źródło:

WebSocket.cs

Zamyka połączenie protokołu WebSocket jako operację asynchroniczną przy użyciu uzgadniania zamknięcia zdefiniowanego w sekcji specyfikacji protokołu WebSocket 7.

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

Wskazuje przyczynę zamknięcia połączenia protokołu WebSocket.

statusDescription

String

Określa czytelne dla człowieka wyjaśnienie, dlaczego połączenie jest zamknięte.

cancellationToken

CancellationToken

Token, który może służyć do propagacji powiadomienia, że operacje powinny zostać anulowane.

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 zamknięciu zestawu WebSocket.

Ta metoda zamyka połączenie protokołu WebSocket przy użyciu ścisłego uzgadniania zdefiniowanego w sekcji specyfikacji protokołu WebSocket 7.