WinHttpWebSocketShutdown

WebSocket サーバーにクローズフレームを送信して送信チャネルを閉じるが、受信チャネルは開いたままにする。

WinHttpWebSocketShutdown hWebSocket, usStatus, pvReason, dwReasonLength

hWebSocket : [intptr] 型: HINTERNET WebSocket へのハンドル。注: WinHttpWebSocketShutdown はこのハンドルを閉じない。ハンドルを閉じるには、不要になった時点で hWebSocket に対して WinHttpCloseHandle を呼び出す。
usStatus : [int] 型: USHORT クローズステータスコード。指定可能な値は WINHTTP_WEB_SOCKET_CLOSE_STATUS を参照。
pvReason : [intptr] 型: PVOID クローズの詳細な理由。
dwReasonLength : [int] 型: DWORD pvReason の長さ (バイト単位)。pvReason が NULL の場合はこれを 0 にしなければならない。値は 0 から 123 の範囲でなければならない。

(プラグイン / モジュール : winhttp.dll)

解説

WebSocket サーバーにクローズフレームを送信して送信チャネルを閉じるが、受信チャネルは開いたままにする。

[戻り値]
型: DWORD 次の例外を除いて、すべてのエラーコードは基礎となる TCP 接続が中断されたことを示す。
（以下省略）

[備考]
WinHttpWebSocketShutdown はクローズフレームを送信し、WebSocket
接続で追加のデータが送信されないようにする。受信チャネルは閉じない。接続を完全に閉じて後続の受信操作を防ぎたい場合は
WinHttpWebSocketClose を使う。アプリケーションは (通常の受信操作で)
サーバーからのクローズフレームを受信する責任がある。WinHttpWebSocketShutdown
を呼び出した後、アプリケーションが自分でクローズフレームを受信する必要がなく、スタックに委ねたい場合は
WinHttpWebSocketClose を呼び出せる。

情報