WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) 方法

定義

命名空間:

System.Net.WebSockets

組件:

System.Net.WebSockets.dll

來源:

WebSocket.cs

以非同步作業使用 WebSocket 通訊協定規格第 7 節中所定義的關閉信號交換，關閉 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

參數

closeStatus

WebSocketCloseStatus

表示關閉 WebSocket 連線的原因。

statusDescription

String

指定易懂的連線結束原因說明。

cancellationToken

CancellationToken

可用來傳播應該取消作業之通知的語彙基元。

傳回

Task

工作物件，表示非同步作業。

例外狀況

OperationCanceledException

取消標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

這項作業不會封鎖。 傳回 Task 的物件會在 WebSocket 關閉之後完成。

此方法會使用 WebSocket 通訊協定規格 第 7 節中定義的關閉交握來關閉 WebSocket 連線。