WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) メソッド

  • リファレンス

定義

名前空間:
System.Net.WebSockets
アセンブリ:
System.Net.WebSockets.dll
アセンブリ:
System.dll
アセンブリ:
netstandard.dll
ソース:
WebSocket.cs
ソース:
WebSocket.cs
ソース:
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);
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 で定義されている close ハンドシェイクを使用して 、WebSocket 接続を閉じます。

適用対象