AspNetWebSocket.CloseAsync Metodo

Definizione

Spazio dei nomi:

System.Web.WebSockets

Assembly:

System.Web.dll

Invia un messaggio asincrono a un client per chiudere la connessione. Se il server avvia la richiesta di chiusura della connessione, il metodo rimane in attesa che il client riconosca la richiesta prima di restituire un risultato.

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

Parametri

closeStatus

WebSocketCloseStatus

Codice di stato dell'operazione di chiusura.

statusDescription

String

Messaggio di stato dell'operazione di chiusura.

cancellationToken

CancellationToken

Oggetto che annulla un'operazione in sospeso.

Restituisce

Task

Riferimento all'operazione.

Eccezioni

ObjectDisposedException

L'oggetto AspNetWebSocket è già stato eliminato.

InvalidOperationException

L'oggetto AspNetWebSocket si trova in uno stato interrotto.

-oppure-

Operazioni di invio non disponibili.

-oppure-

Operazioni di ricezione non disponibili.

OperationCanceledException

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

Commenti

È possibile usare i CloseAsync metodi e CloseOutputAsync per le richieste avviate dal client e avviate dal server per chiudere una AspNetWebSocket connessione. I due metodi gestiscono le richieste avviate dal client nello stesso modo: dopo che il client invia un messaggio al server per chiudere la connessione, il server chiama uno di questi metodi e invia un riconoscimento al client e quindi il metodo restituisce.

Per le richieste avviate dal server, i due metodi funzionano in modo diverso. Il CloseAsync metodo invia un messaggio al client per chiudere la connessione, attendere una risposta e quindi restituisce. Il server non attende altri dati inviati dal client. Al contrario, il CloseOutputAsync metodo invia un messaggio al client per chiudere la connessione e restituisce senza attendere una risposta. Dopo aver restituito il metodo, è possibile chiamare il ReceiveAsync metodo e gestire dati aggiuntivi o il riconoscimento inviato dal client.