ClientWebSocket.CloseAsync Método

Definição

Namespace:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.Client.dll

Origem:

ClientWebSocket.cs

Fecha a instância ClientWebSocket como uma operação assíncrona.

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

Parâmetros

closeStatus

WebSocketCloseStatus

O status de fechamento do WebSocket.

statusDescription

String

Uma descrição do status de fechamento.

cancellationToken

CancellationToken

Um token de cancelamento usado para propagar a notificação de que essa operação deve ser cancelada.

Retornos

Task

O objeto de tarefa que representa a operação assíncrona.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Essa operação não será bloqueada. O objeto retornado Task será concluído depois que a ClientWebSocket instância for fechada.