yhirose
9bfd2ddf1c
Bring the READMEs and the docs pages (en and ja) in line with the current header: - Fix the client sample that does not compile, the Transfer-Encoding statement for default headers, the verifier callback comment, the thread pool spawn rule, the sanitize_filename description, and the inverted Accept-Encoding sentence. - Describe recent behaviour: TLS errors behind Read/Write failures, Host validation, Connection: close for a body without length, content_reader rules, refused CONNECT, WebSocketClient proxies, CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT, the SSE event size limit, and the payload limit of the Stream API. - Complete the API references of WebSocket, WebSocketClient and the stream:: helpers, and the SSE reconnect rules. - Fix cookbook pages: keychain loading on every backend, received Close status, a multipart sample that trusted the client's file name, an echo sample that sent binary as text, SNI, pre-request handler scope, stop() with WebSocket handlers, and the thread pool notes. - Restore the mutex in the LLM app's Chapter 5 code.
4.2 KiB
title, order, status
| title | order | status |
|---|---|---|
| W01. WebSocketエコーサーバー／クライアントを実装する | 52 | draft |
WebSocketは、クライアントとサーバーの間で双方向にメッセージをやり取りするためのプロトコルです。cpp-httplibはサーバーとクライアントの両方のAPIを提供しています。まずは一番シンプルなエコーサーバーから見てみましょう。
サーバー: エコーサーバー
#include <httplib.h>
int main() {
httplib::Server svr;
svr.WebSocket("/echo", [](const httplib::Request &req, httplib::ws::WebSocket &ws) {
std::string msg;
while (ws.is_open()) {
auto result = ws.read(msg);
if (result == httplib::ws::ReadResult::Fail) {
break;
}
// 受け取った内容を同じフレームタイプでそのまま返す
if (result == httplib::ws::ReadResult::Binary) {
ws.send(msg.data(), msg.size());
} else {
ws.send(msg);
}
}
});
svr.listen("0.0.0.0", 8080);
}
svr.WebSocket()でWebSocket用のハンドラを登録します。ハンドラが呼ばれた時点で、すでにWebSocketのハンドシェイクは完了しています。ループの中でws.read()してws.send()するだけで、エコー動作が完成します。バイナリメッセージはdata()とsize()を渡すオーバーロードで返すので、バイナリのまま届きます（詳しくは後述）。
read()の返り値はReadResult列挙値で、次の4種類です。
ReadResult::Text: テキストメッセージを受信ReadResult::Binary: バイナリメッセージを受信ReadResult::Fail: エラー、または接続が閉じたReadResult::Timeout:set_read_timeout()で自分が設定した読み取りタイムアウトが、何も受信しないまま経過した。接続は開いたまま。コンパイル時のデフォルトのタイムアウトは接続を閉じ、Failとして返る（W06. タイムアウトを設定するを参照）
クライアント: エコーを叩く
#include <httplib.h>
int main() {
httplib::ws::WebSocketClient cli("ws://localhost:8080/echo");
if (!cli.connect()) {
std::cerr << "failed to connect" << std::endl;
return 1;
}
cli.send("Hello, WebSocket!");
std::string msg;
if (cli.read(msg) != httplib::ws::ReadResult::Fail) {
std::cout << "received: " << msg << std::endl;
}
cli.close();
}
URLにはws://（平文）またはwss://（TLS）を指定します。connect()でハンドシェイクを行い、あとはsend()とread()でサーバーと同じAPIでやり取りできます。
テキストとバイナリの送り分け
send()には2つのオーバーロードがあり、テキストとバイナリで使い分けられます。
ws.send("Hello"); // テキストフレーム
ws.send(binary_data, binary_data_size); // バイナリフレーム
std::stringを受け取るオーバーロードはテキスト、const char*とサイズを受け取るオーバーロードはバイナリとして送られます。詳しくはW04. バイナリフレームを送受信するを参照してください。
スレッドとの関係
WebSocket接続はハンドラが終わるまで生き続けるので、1接続につきワーカースレッドを1つ占有します。デフォルトのスレッドプールも負荷に応じてベースの4倍まで増えますが、同時接続数が多い場合は、その最大スレッド数を引き上げましょう。
svr.new_task_queue = [] {
return new httplib::ThreadPool(8, 128);
};
詳細はS21. マルチスレッド数を設定するを参照してください。
Note: HTTPSサーバーの上でWebSocketを動かしたいときは、
httplib::Serverの代わりにhttplib::SSLServerを使えば、同じWebSocket()ハンドラがそのまま動きます。クライアント側はwss://スキームを指定するだけです。CA証明書やクライアント証明書の設定はW05. wss接続でTLSを設定するを参照してください。