mirror of
https://github.com/yhirose/cpp-httplib.git
synced 2026-10-28 13:04:03 +00:00
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.
55 lines
2.4 KiB
Markdown
55 lines
2.4 KiB
Markdown
---
|
||
title: "C12. タイムアウトを設定する"
|
||
order: 12
|
||
status: "draft"
|
||
---
|
||
|
||
クライアントには3種類のタイムアウトがあります。それぞれ別々に設定できます。
|
||
|
||
| 種類 | API | デフォルト | 意味 |
|
||
| --- | --- | --- | --- |
|
||
| 接続タイムアウト | `set_connection_timeout` | 300秒 | TCP接続の確立までの待ち時間 |
|
||
| 読み取りタイムアウト | `set_read_timeout` | 300秒 | レスポンスを受信する際の1回の`recv`待ち時間 |
|
||
| 書き込みタイムアウト | `set_write_timeout` | 5秒 | リクエストを送信する際の1回の`send`待ち時間 |
|
||
|
||
HTTPSでは、接続タイムアウトがTLSハンドシェイク全体の制限時間にもなります。時間内にハンドシェイクが終わらないと、`Error::SSLConnection`で失敗します。
|
||
|
||
## 基本の使い方
|
||
|
||
```cpp
|
||
httplib::Client cli("http://localhost:8080");
|
||
|
||
cli.set_connection_timeout(5, 0); // 5秒
|
||
cli.set_read_timeout(10, 0); // 10秒
|
||
cli.set_write_timeout(10, 0); // 10秒
|
||
|
||
auto res = cli.Get("/api/data");
|
||
```
|
||
|
||
秒数とマイクロ秒を2引数で渡します。細かい指定が不要なら第2引数は省略できます。
|
||
|
||
## `std::chrono`で指定する
|
||
|
||
`std::chrono`の期間を直接渡すオーバーロードもあります。こちらのほうが読みやすいのでおすすめです。
|
||
|
||
```cpp
|
||
using namespace std::chrono_literals;
|
||
|
||
cli.set_connection_timeout(5s);
|
||
cli.set_read_timeout(10s);
|
||
cli.set_write_timeout(500ms);
|
||
```
|
||
|
||
## デフォルトでは300秒と長めな点に注意
|
||
|
||
接続タイムアウトと読み取りタイムアウトはデフォルトで**300秒（5分）**です。サーバーが反応しない場合、このままだと5分待たされます。短めに設定したほうが良いことが多いです。
|
||
|
||
```cpp
|
||
cli.set_connection_timeout(3s);
|
||
cli.set_read_timeout(10s);
|
||
```
|
||
|
||
> **Warning:** 読み取りタイムアウトは「1回の受信待ち」に対するタイムアウトです。大きなファイルのダウンロードで途中ずっとデータが流れている限り、リクエスト全体で30分かかっても発火しません。リクエスト全体の時間制限を設けたい場合は[C13. 全体タイムアウトを設定する](../c13-max-timeout)を使ってください。
|
||
|
||
> WebSocketクライアントのタイムアウト設定は[W06. タイムアウトを設定する](../w06-websocket-timeouts)を参照してください。
|