mirror of
https://github.com/yhirose/cpp-httplib.git
synced 2026-10-19 11:19:36 +00:00
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.
55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
---
|
|
title: "C12. Set Timeouts"
|
|
order: 12
|
|
status: "draft"
|
|
---
|
|
|
|
The client has three kinds of timeouts, each set independently.
|
|
|
|
| Kind | API | Default | Meaning |
|
|
| --- | --- | --- | --- |
|
|
| Connection | `set_connection_timeout` | 300s | Time to wait for the TCP connection to establish |
|
|
| Read | `set_read_timeout` | 300s | Time to wait for a single `recv` when receiving the response |
|
|
| Write | `set_write_timeout` | 5s | Time to wait for a single `send` when sending the request |
|
|
|
|
Over HTTPS, the connection timeout also bounds the whole TLS handshake. A handshake that doesn't finish in time fails with `Error::SSLConnection`.
|
|
|
|
## Basic usage
|
|
|
|
```cpp
|
|
httplib::Client cli("http://localhost:8080");
|
|
|
|
cli.set_connection_timeout(5, 0); // 5 seconds
|
|
cli.set_read_timeout(10, 0); // 10 seconds
|
|
cli.set_write_timeout(10, 0); // 10 seconds
|
|
|
|
auto res = cli.Get("/api/data");
|
|
```
|
|
|
|
Pass seconds and microseconds as two arguments. If you don't need the sub-second part, you can omit the second argument.
|
|
|
|
## Use `std::chrono`
|
|
|
|
There's also an overload that takes a `std::chrono` duration directly. It's easier to read — recommended.
|
|
|
|
```cpp
|
|
using namespace std::chrono_literals;
|
|
|
|
cli.set_connection_timeout(5s);
|
|
cli.set_read_timeout(10s);
|
|
cli.set_write_timeout(500ms);
|
|
```
|
|
|
|
## Watch out for the long 300s default
|
|
|
|
Connection and read timeouts default to **300 seconds (5 minutes)**. If the server hangs, you'll be waiting five minutes by default. Shorter values are usually a better idea.
|
|
|
|
```cpp
|
|
cli.set_connection_timeout(3s);
|
|
cli.set_read_timeout(10s);
|
|
```
|
|
|
|
> **Warning:** The read timeout covers a single receive call — not the whole request. If data keeps trickling in during a large download, the request can take half an hour without ever hitting the timeout. To cap the total request time, use [C13. Set an overall timeout](../c13-max-timeout).
|
|
|
|
> For WebSocket client timeouts, see [W06. Set Timeouts](../w06-websocket-timeouts).
|