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 完了します。