WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) Метод

Определение

Пространство имен:

System.Net.WebSockets

Сборка:

System.Net.WebSockets.dll

Исходный код:

WebSocket.cs

Закрывает подключение WebSocket в качестве асинхронной операции, используя подтверждение закрытия, которое определено в разделе 7 спецификации протокола 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

Параметры

closeStatus

WebSocketCloseStatus

Указывает причину закрытия соединения WebSocket.

statusDescription

String

Задает объяснение причины закрытия соединения в понятном для человека формате.

cancellationToken

CancellationToken

Токен, который можно использовать для распространения уведомления о том, что операции нужно отменить.

Возвращаемое значение

Task

Объект задачи, представляющий асинхронную операцию.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.

Комментарии

Эта операция не блокируется. Возвращенный Task объект завершится после закрытия WebSocket.

Этот метод закрывает подключение WebSocket с помощью подтверждения закрытия, определенного в разделе 7 спецификации протокола WebSocket .