ClientWebSocket.CloseAsync Метод

Определение

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

System.Net.WebSockets

Сборка:

System.Net.WebSockets.Client.dll

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

ClientWebSocket.cs

Закрывает экземпляр ClientWebSocket как асинхронную операцию.

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

Параметры

closeStatus

WebSocketCloseStatus

Состояние закрытия WebSocket.

statusDescription

String

Описание состояния закрытия.

cancellationToken

CancellationToken

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

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

Task

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

Исключения

OperationCanceledException

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

Комментарии

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