WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) Metodo

Definizione

Spazio dei nomi:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.dll

Origine:

WebSocket.cs

Chiude la connessione WebSocket come operazione asincrona usando l'handshake di chiusura definito nella sezione 7 della specifica del protocollo 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

Parametri

closeStatus

WebSocketCloseStatus

Indica il motivo della chiusura della connessione WebSocket.

statusDescription

String

Specifica una spiegazione leggibile del motivo della chiusura della connessione.

cancellationToken

CancellationToken

Token che può essere utilizzato per propagare la notifica della richiesta di annullamento delle operazioni.

Restituisce

Task

Oggetto dell'attività che rappresenta l'operazione asincrona.

Eccezioni

OperationCanceledException

Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.

Commenti

Questa operazione non verrà bloccata. L'oggetto restituito Task verrà completato dopo la chiusura del WebSocket.

Questo metodo chiude la connessione WebSocket usando la handshake chiusa definita nella specifica del protocollo WebSocket sezione 7.