WebSocket.CloseOutputAsync メソッド

定義

名前空間:

System.Net.WebSockets

アセンブリ:

System.Net.WebSockets.dll

ソース:

WebSocket.cs

WebSocket プロトコル仕様のセクション 7 で定義されている終了ハンドシェイクを開始または完了します。

public:
 abstract System::Threading::Tasks::Task ^ CloseOutputAsync(System::Net::WebSockets::WebSocketCloseStatus closeStatus, System::String ^ statusDescription, System::Threading::CancellationToken cancellationToken);

public abstract System.Threading.Tasks.Task CloseOutputAsync (System.Net.WebSockets.WebSocketCloseStatus closeStatus, string? statusDescription, System.Threading.CancellationToken cancellationToken);

abstract member CloseOutputAsync : System.Net.WebSockets.WebSocketCloseStatus * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public MustOverride Function CloseOutputAsync (closeStatus As WebSocketCloseStatus, statusDescription As String, cancellationToken As CancellationToken) As Task

パラメーター

closeStatus

WebSocketCloseStatus

WebSocket 接続を閉じる理由を示します。

statusDescription

String

接続が閉じられた理由について人間が判読可能な説明をアプリケーションが指定できるようにします。

cancellationToken

CancellationToken

操作を取り消す必要があることを示す通知を伝達するために使用可能なトークン。

戻り値

Task

非同期操作を表すタスク オブジェクト。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

この操作はブロックされません。 返された Task オブジェクトは、WebSocket の出力が閉じられた後に完了します。