cpp-httplib v0.52.0
DRAFT

W06. タイムアウトを設定する

ws::WebSocketClientにはClientと同じ3種類のタイムアウトがあり、意味も同じです。

種類APIデフォルト
接続タイムアウトset_connection_timeout300秒
読み取りタイムアウトset_read_timeout300秒（CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND）
書き込みタイムアウトset_write_timeout5秒

基本の使い方

httplib::ws::WebSocketClient ws("ws://localhost:8080/ws");

ws.set_connection_timeout(5, 0);  // 5秒
ws.set_read_timeout(30, 0);       // 30秒
ws.set_write_timeout(10, 0);      // 10秒

if (ws.connect()) {
  ws.send("hello");
}

httplib::ws::WebSocketClient ws("ws://localhost:8080/ws");

ws.set_connection_timeout(5, 0);  // 5秒
ws.set_read_timeout(30, 0);       // 30秒
ws.set_write_timeout(10, 0);      // 10秒

if (ws.connect()) {
  ws.send("hello");
}

connect()を呼ぶ前に設定してください。

std::chronoで指定する

Clientと同じく、std::chronoの期間を直接渡すオーバーロードもあります。

using namespace std::chrono_literals;

ws.set_connection_timeout(5s);
ws.set_read_timeout(30s);
ws.set_write_timeout(10s);

using namespace std::chrono_literals;

ws.set_connection_timeout(5s);
ws.set_read_timeout(30s);
ws.set_write_timeout(10s);

読み取りタイムアウトの意味に注意

set_read_timeout()は「1回のread()呼び出し」に対するタイムアウトです。メッセージが届かないまま指定時間が経過するとread()がReadResult::Failを返します。通知の待受のように長時間メッセージが来ないことが正常な接続では、意図せず切断されないよう長めに設定するか、切断されたらアプリケーション側で再接続してください。

Ping/Pongによる無応答ピア検出は別の仕組みです。詳しくはW02. ハートビートを設定するを参照してください。

Clientとの違い

Clientのタイムアウト設定についてはC12. タイムアウトを設定するを参照してください。挙動とAPIはほぼ同じですが、WebSocketClientにはset_max_timeout()に相当するリクエスト全体のタイムアウトはありません。接続を確立したあとは、read()のループを回し続ける限り接続が維持されます。

ESC