ClientWebSocket.CloseAsync 方法

定義

命名空間:

System.Net.WebSockets

組件:

System.Net.WebSockets.Client.dll

來源:

ClientWebSocket.cs

以非同步作業方式關閉 ClientWebSocket 執行個體。

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

參數

closeStatus

WebSocketCloseStatus

WebSocket 關閉狀態。

statusDescription

String

關閉狀態的描述。

cancellationToken

CancellationToken

這個取消語彙基元是用來傳播應該取消這項作業的通知。

傳回

Task

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

例外狀況

OperationCanceledException

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

備註

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