WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) Método

Definição

Namespace:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.dll

Origem:

WebSocket.cs

Fecha a conexão WebSocket como uma operação assíncrona usando o handshake de fechamento definido na seção 7 da especificação do protocolo 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

Parâmetros

closeStatus

WebSocketCloseStatus

Indica o motivo para fechar a conexão WebSocket.

statusDescription

String

Especifica uma explicação legível humana relacionada ao motivo pelo qual a conexão é fechada.

cancellationToken

CancellationToken

O token que pode ser usado para propagar a notificação de que as operações devem ser canceladas.

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

Esta operação não será bloqueada. O objeto retornado Task será concluído depois que o WebSocket for fechado.

Esse método fecha a conexão WebSocket usando o handshake close definido na seção 7 da especificação do protocolo WebSocket .