cpp-httplib/docs-src/pages/ja/cookbook/w02-websocket-ping.md

title, order, status

title	order	status
W02. ハートビートを設定する	52	draft

WebSocket接続は長時間つなぎっぱなしになるので、プロキシやロードバランサが「アイドルだから」と勝手に切ってしまうことがあります。これを防ぐために、定期的にPingフレームを送って接続を生かしておく仕組みがあります。cpp-httplibでは、指定した間隔で自動的にPingを送ってくれます。

サーバー側の設定

svr.set_websocket_ping_interval(30); // 30秒ごとにPing

svr.WebSocket("/chat", [](const auto &req, auto &ws) {
  // ...
});

set_websocket_ping_interval()に秒数を渡すだけです。このサーバーが受け入れるすべてのWebSocket接続に対して、指定した間隔でPingが送られます。

std::chronoの期間を受け取るオーバーロードもあります。

using namespace std::chrono_literals;
svr.set_websocket_ping_interval(30s);

クライアント側の設定

クライアント側でも同じAPIがあります。

httplib::ws::WebSocketClient cli("ws://localhost:8080/chat");
cli.set_websocket_ping_interval(30);
cli.connect();

connect()を呼ぶ前に設定しておきましょう。

デフォルト値

デフォルトのPing間隔は、ビルド時のマクロCPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECONDで決まります。通常はそのままで問題ありませんが、特別なプロキシ環境に合わせて短くしたい場合は調整してください。

PongはどうやってpIngに応答するか

WebSocketプロトコルでは、PingフレームにはPongフレームで応答することが決まっています。cpp-httplibは受信したPingに自動でPongを返すので、アプリケーションコード側で気にする必要はありません。

Pingの間隔をどう決めるか

環境	推奨
通常のインターネット接続	30〜60秒
厳しいプロキシ（AWS ALBなど）	15〜30秒
モバイル回線	短すぎるとバッテリーを食う、60秒以上

短すぎると無駄なトラフィックになり、長すぎると接続が切れます。だいたい接続が切れる時間の半分くらいが目安です。

Warning: Ping間隔を極端に短くすると、WebSocket接続ごとにバックグラウンドでスレッドが走るので、CPU負荷が上がります。接続数が多いサーバーでは控えめな値に設定しましょう。

接続が閉じたときの処理はW03. 接続クローズをハンドリングするを参照してください。