mirror of
https://github.com/yhirose/cpp-httplib.git
synced 2026-04-13 04:08:30 +00:00
Remove docs-gen
This commit is contained in:
yhirose
@@ -17,16 +17,16 @@
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-inner">
|
||||
<a href="/cpp-httplib/en/" class="header-title">cpp-httplib <span style="font-size:0.75em;font-weight:normal;margin-left:4px">v0.36.0</span></a>
|
||||
<a href="/cpp-httplib/en/" class="header-title">cpp-httplib <span style="font-size:0.75em;font-weight:normal;margin-left:4px">v0.36.0</span></a>
|
||||
<div class="header-spacer"></div>
|
||||
<nav class="header-nav">
|
||||
<a href="/cpp-httplib/en/">
|
||||
<a href="/cpp-httplib/en/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M3 9l9-7 9 7v11a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2z"/><polyline points="9 22 9 12 15 12 15 22"/></svg>
|
||||
Home
|
||||
</a>
|
||||
|
||||
|
||||
<a href="/cpp-httplib/en/tour/">
|
||||
<a href="/cpp-httplib/en/tour/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"/><polygon points="16.24 7.76 14.12 14.12 7.76 16.24 9.88 9.88 16.24 7.76"/></svg>
|
||||
Tour
|
||||
</a>
|
||||
@@ -45,6 +45,7 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="11" cy="11" r="8"/><line x1="21" y1="21" x2="16.65" y2="16.65"/></svg>
|
||||
</button>
|
||||
<button class="theme-toggle" aria-label="Toggle theme"></button>
|
||||
|
||||
<div class="lang-selector">
|
||||
<button class="lang-btn" aria-label="Language">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"/><line x1="2" y1="12" x2="22" y2="12"/><path d="M12 2a15.3 15.3 0 0 1 4 10 15.3 15.3 0 0 1-4 10 15.3 15.3 0 0 1-4-10 15.3 15.3 0 0 1 4-10z"/></svg>
|
||||
@@ -58,6 +59,7 @@
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<button class="sidebar-toggle" aria-label="Menu">☰</button>
|
||||
</div>
|
||||
@@ -105,16 +107,16 @@
|
||||
<p>Great job finishing the Tour! You now have a solid grasp of the cpp-httplib basics. But there's a lot more to explore. Here's a quick overview of features we didn't cover in the Tour, organized by category.</p>
|
||||
<h2>Streaming API</h2>
|
||||
<p>When you're working with LLM streaming responses or downloading large files, you don't want to load the entire response into memory. Use <code>stream::Get()</code> to process data chunk by chunk.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">http://localhost:11434</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#cc99cc;">auto</span><span style="color:#d3d0c8;"> result = </span><span style="color:#6699cc;">httplib::stream::Get</span><span style="color:#d3d0c8;">(cli, "</span><span style="color:#99cc99;">/api/generate</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#cc99cc;">if </span><span style="color:#d3d0c8;">(result) {
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#cc99cc;">while </span><span style="color:#d3d0c8;">(result.</span><span style="color:#6699cc;">next</span><span style="color:#d3d0c8;">()) {
|
||||
</span><span style="color:#d3d0c8;"> std::cout.</span><span style="color:#6699cc;">write</span><span style="color:#d3d0c8;">(result.</span><span style="color:#6699cc;">data</span><span style="color:#d3d0c8;">(), result.</span><span style="color:#6699cc;">size</span><span style="color:#d3d0c8;">());
|
||||
</span><span style="color:#d3d0c8;"> }
|
||||
</span><span style="color:#d3d0c8;">}
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">http://localhost:11434</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#b48ead;">auto</span><span style="color:#c0c5ce;"> result = </span><span style="color:#8fa1b3;">httplib::stream::Get</span><span style="color:#c0c5ce;">(cli, "</span><span style="color:#a3be8c;">/api/generate</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#b48ead;">if </span><span style="color:#c0c5ce;">(result) {
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">while </span><span style="color:#c0c5ce;">(result.</span><span style="color:#8fa1b3;">next</span><span style="color:#c0c5ce;">()) {
|
||||
</span><span style="color:#c0c5ce;"> std::cout.</span><span style="color:#8fa1b3;">write</span><span style="color:#c0c5ce;">(result.</span><span style="color:#8fa1b3;">data</span><span style="color:#c0c5ce;">(), result.</span><span style="color:#8fa1b3;">size</span><span style="color:#c0c5ce;">());
|
||||
</span><span style="color:#c0c5ce;"> }
|
||||
</span><span style="color:#c0c5ce;">}
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">httplib::Client </span><span style="font-weight:bold;color:#795da3;">cli</span><span style="color:#323232;">(</span><span style="color:#183691;">"http://localhost:11434"</span><span style="color:#323232;">);
|
||||
@@ -129,13 +131,13 @@
|
||||
</span></pre>
|
||||
</div></div>
|
||||
<p>You can also pass a <code>content_receiver</code> callback to <code>Get()</code>. This approach works with Keep-Alive.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">http://localhost:8080</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">Get</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">/stream</span><span style="color:#d3d0c8;">", [](</span><span style="color:#cc99cc;">const char </span><span style="color:#d3d0c8;">*data, size_t len) {
|
||||
</span><span style="color:#d3d0c8;"> std::cout.</span><span style="color:#6699cc;">write</span><span style="color:#d3d0c8;">(data, len);
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#cc99cc;">return </span><span style="color:#f99157;">true</span><span style="color:#d3d0c8;">;
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">http://localhost:8080</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">/stream</span><span style="color:#c0c5ce;">", [](</span><span style="color:#b48ead;">const char </span><span style="color:#c0c5ce;">*data, size_t len) {
|
||||
</span><span style="color:#c0c5ce;"> std::cout.</span><span style="color:#8fa1b3;">write</span><span style="color:#c0c5ce;">(data, len);
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">return </span><span style="color:#d08770;">true</span><span style="color:#c0c5ce;">;
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">httplib::Client </span><span style="font-weight:bold;color:#795da3;">cli</span><span style="color:#323232;">(</span><span style="color:#183691;">"http://localhost:8080"</span><span style="color:#323232;">);
|
||||
@@ -147,25 +149,25 @@
|
||||
</span></pre>
|
||||
</div></div>
|
||||
<p>On the server side, you have <code>set_content_provider()</code> and <code>set_chunked_content_provider()</code>. Use the former when you know the size, and the latter when you don't.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#747369;">// With known size (sets Content-Length)
|
||||
</span><span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">Get</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">/file</span><span style="color:#d3d0c8;">", [](</span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&, </span><span style="color:#cc99cc;">auto </span><span style="color:#d3d0c8;">&res) {
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#cc99cc;">auto</span><span style="color:#d3d0c8;"> size = </span><span style="color:#6699cc;">get_file_size</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">large.bin</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;"> res.</span><span style="color:#6699cc;">set_content_provider</span><span style="color:#d3d0c8;">(size, "</span><span style="color:#99cc99;">application/octet-stream</span><span style="color:#d3d0c8;">",
|
||||
</span><span style="color:#d3d0c8;"> [](size_t offset, size_t length, httplib::DataSink &sink) {
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#747369;">// Send 'length' bytes starting from 'offset'
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#cc99cc;">return </span><span style="color:#f99157;">true</span><span style="color:#d3d0c8;">;
|
||||
</span><span style="color:#d3d0c8;"> });
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#747369;">// Unknown size (Chunked Transfer Encoding)
|
||||
</span><span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">Get</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">/stream</span><span style="color:#d3d0c8;">", [](</span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&, </span><span style="color:#cc99cc;">auto </span><span style="color:#d3d0c8;">&res) {
|
||||
</span><span style="color:#d3d0c8;"> res.</span><span style="color:#6699cc;">set_chunked_content_provider</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">text/plain</span><span style="color:#d3d0c8;">",
|
||||
</span><span style="color:#d3d0c8;"> [](size_t offset, httplib::DataSink &sink) {
|
||||
</span><span style="color:#d3d0c8;"> sink.</span><span style="color:#6699cc;">write</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">chunk</span><span style="color:#66cccc;">\n</span><span style="color:#d3d0c8;">", </span><span style="color:#f99157;">6</span><span style="color:#d3d0c8;">);
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#cc99cc;">return </span><span style="color:#f99157;">true</span><span style="color:#d3d0c8;">; </span><span style="color:#747369;">// Return false to finish
|
||||
</span><span style="color:#d3d0c8;"> });
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#65737e;">// With known size (sets Content-Length)
|
||||
</span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">/file</span><span style="color:#c0c5ce;">", [](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&res) {
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">auto</span><span style="color:#c0c5ce;"> size = </span><span style="color:#8fa1b3;">get_file_size</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">large.bin</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_content_provider</span><span style="color:#c0c5ce;">(size, "</span><span style="color:#a3be8c;">application/octet-stream</span><span style="color:#c0c5ce;">",
|
||||
</span><span style="color:#c0c5ce;"> [](size_t offset, size_t length, httplib::DataSink &sink) {
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#65737e;">// Send 'length' bytes starting from 'offset'
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">return </span><span style="color:#d08770;">true</span><span style="color:#c0c5ce;">;
|
||||
</span><span style="color:#c0c5ce;"> });
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#65737e;">// Unknown size (Chunked Transfer Encoding)
|
||||
</span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">/stream</span><span style="color:#c0c5ce;">", [](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&res) {
|
||||
</span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_chunked_content_provider</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">text/plain</span><span style="color:#c0c5ce;">",
|
||||
</span><span style="color:#c0c5ce;"> [](size_t offset, httplib::DataSink &sink) {
|
||||
</span><span style="color:#c0c5ce;"> sink.</span><span style="color:#8fa1b3;">write</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">chunk</span><span style="color:#96b5b4;">\n</span><span style="color:#c0c5ce;">", </span><span style="color:#d08770;">6</span><span style="color:#c0c5ce;">);
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">return </span><span style="color:#d08770;">true</span><span style="color:#c0c5ce;">; </span><span style="color:#65737e;">// Return false to finish
|
||||
</span><span style="color:#c0c5ce;"> });
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="font-style:italic;color:#969896;">// With known size (sets Content-Length)
|
||||
@@ -189,12 +191,12 @@
|
||||
</span></pre>
|
||||
</div></div>
|
||||
<p>For uploading large files, <code>make_file_provider()</code> comes in handy. It streams the file instead of loading it all into memory.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">http://localhost:8080</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#cc99cc;">auto</span><span style="color:#d3d0c8;"> res = cli.</span><span style="color:#6699cc;">Post</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">/upload</span><span style="color:#d3d0c8;">", {}, {
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#6699cc;">httplib::make_file_provider</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">file</span><span style="color:#d3d0c8;">", "</span><span style="color:#99cc99;">/path/to/large-file.zip</span><span style="color:#d3d0c8;">")
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">http://localhost:8080</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#b48ead;">auto</span><span style="color:#c0c5ce;"> res = cli.</span><span style="color:#8fa1b3;">Post</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">/upload</span><span style="color:#c0c5ce;">", {}, {
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#8fa1b3;">httplib::make_file_provider</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">file</span><span style="color:#c0c5ce;">", "</span><span style="color:#a3be8c;">/path/to/large-file.zip</span><span style="color:#c0c5ce;">")
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">httplib::Client </span><span style="font-weight:bold;color:#795da3;">cli</span><span style="color:#323232;">(</span><span style="color:#183691;">"http://localhost:8080"</span><span style="color:#323232;">);
|
||||
@@ -206,15 +208,15 @@
|
||||
</div></div>
|
||||
<h2>Server-Sent Events (SSE)</h2>
|
||||
<p>We provide an SSE client as well. It supports automatic reconnection and resuming via <code>Last-Event-ID</code>.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">http://localhost:8080</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">httplib::sse::SSEClient </span><span style="color:#6699cc;">sse</span><span style="color:#d3d0c8;">(</span><span style="color:#f2777a;">cli</span><span style="color:#d3d0c8;">, "</span><span style="color:#99cc99;">/events</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#d3d0c8;">sse.</span><span style="color:#6699cc;">on_message</span><span style="color:#d3d0c8;">([](</span><span style="color:#cc99cc;">const</span><span style="color:#d3d0c8;"> httplib::sse::SSEMessage &msg) {
|
||||
</span><span style="color:#d3d0c8;"> std::cout << msg.</span><span style="color:#f2777a;">event </span><span style="color:#d3d0c8;"><< "</span><span style="color:#99cc99;">: </span><span style="color:#d3d0c8;">" << msg.</span><span style="color:#f2777a;">data </span><span style="color:#d3d0c8;"><< std::endl;
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#d3d0c8;">sse.</span><span style="color:#6699cc;">start</span><span style="color:#d3d0c8;">(); </span><span style="color:#747369;">// Blocking, with auto-reconnection
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">http://localhost:8080</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">httplib::sse::SSEClient </span><span style="color:#8fa1b3;">sse</span><span style="color:#c0c5ce;">(</span><span style="color:#bf616a;">cli</span><span style="color:#c0c5ce;">, "</span><span style="color:#a3be8c;">/events</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#c0c5ce;">sse.</span><span style="color:#8fa1b3;">on_message</span><span style="color:#c0c5ce;">([](</span><span style="color:#b48ead;">const</span><span style="color:#c0c5ce;"> httplib::sse::SSEMessage &msg) {
|
||||
</span><span style="color:#c0c5ce;"> std::cout << msg.</span><span style="color:#bf616a;">event </span><span style="color:#c0c5ce;"><< "</span><span style="color:#a3be8c;">: </span><span style="color:#c0c5ce;">" << msg.</span><span style="color:#bf616a;">data </span><span style="color:#c0c5ce;"><< std::endl;
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#c0c5ce;">sse.</span><span style="color:#8fa1b3;">start</span><span style="color:#c0c5ce;">(); </span><span style="color:#65737e;">// Blocking, with auto-reconnection
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">httplib::Client </span><span style="font-weight:bold;color:#795da3;">cli</span><span style="color:#323232;">(</span><span style="color:#183691;">"http://localhost:8080"</span><span style="color:#323232;">);
|
||||
@@ -228,10 +230,10 @@
|
||||
</span></pre>
|
||||
</div></div>
|
||||
<p>You can also set separate handlers for each event type.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">sse.</span><span style="color:#6699cc;">on_event</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">update</span><span style="color:#d3d0c8;">", [](</span><span style="color:#cc99cc;">const</span><span style="color:#d3d0c8;"> httplib::sse::SSEMessage &msg) {
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#747369;">// Only handles "update" events
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">sse.</span><span style="color:#8fa1b3;">on_event</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">update</span><span style="color:#c0c5ce;">", [](</span><span style="color:#b48ead;">const</span><span style="color:#c0c5ce;"> httplib::sse::SSEMessage &msg) {
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#65737e;">// Only handles "update" events
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">sse.on_event(</span><span style="color:#183691;">"update"</span><span style="color:#323232;">, [](</span><span style="font-weight:bold;color:#a71d5d;">const</span><span style="color:#323232;"> httplib::sse::SSEMessage </span><span style="font-weight:bold;color:#a71d5d;">&</span><span style="color:#323232;">msg) {
|
||||
@@ -241,10 +243,10 @@
|
||||
</div></div>
|
||||
<h2>Authentication</h2>
|
||||
<p>The client has helpers for Basic auth, Bearer Token auth, and Digest auth.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">https://api.example.com</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_basic_auth</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">user</span><span style="color:#d3d0c8;">", "</span><span style="color:#99cc99;">password</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_bearer_token_auth</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">my-token</span><span style="color:#d3d0c8;">");
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">https://api.example.com</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_basic_auth</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">user</span><span style="color:#c0c5ce;">", "</span><span style="color:#a3be8c;">password</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_bearer_token_auth</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">my-token</span><span style="color:#c0c5ce;">");
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">httplib::Client </span><span style="font-weight:bold;color:#795da3;">cli</span><span style="color:#323232;">(</span><span style="color:#183691;">"https://api.example.com"</span><span style="color:#323232;">);
|
||||
@@ -259,10 +261,10 @@
|
||||
<tr><td>Brotli</td><td><code>CPPHTTPLIB_BROTLI_SUPPORT</code></td></tr>
|
||||
<tr><td>Zstandard</td><td><code>CPPHTTPLIB_ZSTD_SUPPORT</code></td></tr>
|
||||
</tbody></table>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">https://example.com</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_compress</span><span style="color:#d3d0c8;">(</span><span style="color:#f99157;">true</span><span style="color:#d3d0c8;">); </span><span style="color:#747369;">// Compress request body
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_decompress</span><span style="color:#d3d0c8;">(</span><span style="color:#f99157;">true</span><span style="color:#d3d0c8;">); </span><span style="color:#747369;">// Decompress response body
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">https://example.com</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_compress</span><span style="color:#c0c5ce;">(</span><span style="color:#d08770;">true</span><span style="color:#c0c5ce;">); </span><span style="color:#65737e;">// Compress request body
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_decompress</span><span style="color:#c0c5ce;">(</span><span style="color:#d08770;">true</span><span style="color:#c0c5ce;">); </span><span style="color:#65737e;">// Decompress response body
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">httplib::Client </span><span style="font-weight:bold;color:#795da3;">cli</span><span style="color:#323232;">(</span><span style="color:#183691;">"https://example.com"</span><span style="color:#323232;">);
|
||||
@@ -272,10 +274,10 @@
|
||||
</div></div>
|
||||
<h2>Proxy</h2>
|
||||
<p>You can connect through an HTTP proxy.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">https://example.com</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_proxy</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">proxy.example.com</span><span style="color:#d3d0c8;">", </span><span style="color:#f99157;">8080</span><span style="color:#d3d0c8;">);
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_proxy_basic_auth</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">user</span><span style="color:#d3d0c8;">", "</span><span style="color:#99cc99;">password</span><span style="color:#d3d0c8;">");
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">https://example.com</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_proxy</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">proxy.example.com</span><span style="color:#c0c5ce;">", </span><span style="color:#d08770;">8080</span><span style="color:#c0c5ce;">);
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_proxy_basic_auth</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">user</span><span style="color:#c0c5ce;">", "</span><span style="color:#a3be8c;">password</span><span style="color:#c0c5ce;">");
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">httplib::Client </span><span style="font-weight:bold;color:#795da3;">cli</span><span style="color:#323232;">(</span><span style="color:#183691;">"https://example.com"</span><span style="color:#323232;">);
|
||||
@@ -285,11 +287,11 @@
|
||||
</div></div>
|
||||
<h2>Timeouts</h2>
|
||||
<p>You can set connection, read, and write timeouts individually.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">https://example.com</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_connection_timeout</span><span style="color:#d3d0c8;">(</span><span style="color:#f99157;">5</span><span style="color:#d3d0c8;">, </span><span style="color:#f99157;">0</span><span style="color:#d3d0c8;">); </span><span style="color:#747369;">// 5 seconds
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_read_timeout</span><span style="color:#d3d0c8;">(</span><span style="color:#f99157;">10</span><span style="color:#d3d0c8;">, </span><span style="color:#f99157;">0</span><span style="color:#d3d0c8;">); </span><span style="color:#747369;">// 10 seconds
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_write_timeout</span><span style="color:#d3d0c8;">(</span><span style="color:#f99157;">10</span><span style="color:#d3d0c8;">, </span><span style="color:#f99157;">0</span><span style="color:#d3d0c8;">); </span><span style="color:#747369;">// 10 seconds
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">https://example.com</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_connection_timeout</span><span style="color:#c0c5ce;">(</span><span style="color:#d08770;">5</span><span style="color:#c0c5ce;">, </span><span style="color:#d08770;">0</span><span style="color:#c0c5ce;">); </span><span style="color:#65737e;">// 5 seconds
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_read_timeout</span><span style="color:#c0c5ce;">(</span><span style="color:#d08770;">10</span><span style="color:#c0c5ce;">, </span><span style="color:#d08770;">0</span><span style="color:#c0c5ce;">); </span><span style="color:#65737e;">// 10 seconds
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_write_timeout</span><span style="color:#c0c5ce;">(</span><span style="color:#d08770;">10</span><span style="color:#c0c5ce;">, </span><span style="color:#d08770;">0</span><span style="color:#c0c5ce;">); </span><span style="color:#65737e;">// 10 seconds
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">httplib::Client </span><span style="font-weight:bold;color:#795da3;">cli</span><span style="color:#323232;">(</span><span style="color:#183691;">"https://example.com"</span><span style="color:#323232;">);
|
||||
@@ -300,9 +302,9 @@
|
||||
</div></div>
|
||||
<h2>Keep-Alive</h2>
|
||||
<p>If you're making multiple requests to the same server, enable Keep-Alive. It reuses the TCP connection, which is much more efficient.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">https://example.com</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_keep_alive</span><span style="color:#d3d0c8;">(</span><span style="color:#f99157;">true</span><span style="color:#d3d0c8;">);
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">https://example.com</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_keep_alive</span><span style="color:#c0c5ce;">(</span><span style="color:#d08770;">true</span><span style="color:#c0c5ce;">);
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">httplib::Client </span><span style="font-weight:bold;color:#795da3;">cli</span><span style="color:#323232;">(</span><span style="color:#183691;">"https://example.com"</span><span style="color:#323232;">);
|
||||
@@ -311,16 +313,16 @@
|
||||
</div></div>
|
||||
<h2>Server Middleware</h2>
|
||||
<p>You can hook into request processing before and after handlers run.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">set_pre_routing_handler</span><span style="color:#d3d0c8;">([](</span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&req, </span><span style="color:#cc99cc;">auto </span><span style="color:#d3d0c8;">&res) {
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#747369;">// Runs before every request
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#cc99cc;">return</span><span style="color:#d3d0c8;"> httplib::Server::HandlerResponse::Unhandled; </span><span style="color:#747369;">// Continue to normal routing
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">set_post_routing_handler</span><span style="color:#d3d0c8;">([](</span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&req, </span><span style="color:#cc99cc;">auto </span><span style="color:#d3d0c8;">&res) {
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#747369;">// Runs after the response is sent
|
||||
</span><span style="color:#d3d0c8;"> res.</span><span style="color:#6699cc;">set_header</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">X-Server</span><span style="color:#d3d0c8;">", "</span><span style="color:#99cc99;">cpp-httplib</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">set_pre_routing_handler</span><span style="color:#c0c5ce;">([](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&res) {
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#65737e;">// Runs before every request
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">return</span><span style="color:#c0c5ce;"> httplib::Server::HandlerResponse::Unhandled; </span><span style="color:#65737e;">// Continue to normal routing
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">set_post_routing_handler</span><span style="color:#c0c5ce;">([](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&res) {
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#65737e;">// Runs after the response is sent
|
||||
</span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_header</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">X-Server</span><span style="color:#c0c5ce;">", "</span><span style="color:#a3be8c;">cpp-httplib</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">svr.set_pre_routing_handler([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">auto &</span><span style="color:#323232;">res) {
|
||||
@@ -335,16 +337,16 @@
|
||||
</span></pre>
|
||||
</div></div>
|
||||
<p>Use <code>req.user_data</code> to pass data from middleware to handlers. This is useful for sharing things like decoded auth tokens.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">set_pre_routing_handler</span><span style="color:#d3d0c8;">([](</span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&req, </span><span style="color:#cc99cc;">auto </span><span style="color:#d3d0c8;">&res) {
|
||||
</span><span style="color:#d3d0c8;"> req.</span><span style="color:#f2777a;">user_data</span><span style="color:#d3d0c8;">["</span><span style="color:#99cc99;">auth_user</span><span style="color:#d3d0c8;">"] = </span><span style="color:#6699cc;">std::string</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">alice</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#cc99cc;">return</span><span style="color:#d3d0c8;"> httplib::Server::HandlerResponse::Unhandled;
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">Get</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">/me</span><span style="color:#d3d0c8;">", [](</span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&req, </span><span style="color:#cc99cc;">auto </span><span style="color:#d3d0c8;">&res) {
|
||||
</span><span style="color:#d3d0c8;"> </span><span style="color:#cc99cc;">auto</span><span style="color:#d3d0c8;"> user = std::</span><span style="color:#6699cc;">any_cast</span><span style="color:#d3d0c8;"><std::string>(req.</span><span style="color:#f2777a;">user_data</span><span style="color:#d3d0c8;">.</span><span style="color:#6699cc;">at</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">auth_user</span><span style="color:#d3d0c8;">"));
|
||||
</span><span style="color:#d3d0c8;"> res.</span><span style="color:#6699cc;">set_content</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">Hello, </span><span style="color:#d3d0c8;">" + user, "</span><span style="color:#99cc99;">text/plain</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">set_pre_routing_handler</span><span style="color:#c0c5ce;">([](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&res) {
|
||||
</span><span style="color:#c0c5ce;"> req.</span><span style="color:#bf616a;">user_data</span><span style="color:#c0c5ce;">["</span><span style="color:#a3be8c;">auth_user</span><span style="color:#c0c5ce;">"] = </span><span style="color:#8fa1b3;">std::string</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">alice</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">return</span><span style="color:#c0c5ce;"> httplib::Server::HandlerResponse::Unhandled;
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">/me</span><span style="color:#c0c5ce;">", [](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&res) {
|
||||
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">auto</span><span style="color:#c0c5ce;"> user = std::</span><span style="color:#8fa1b3;">any_cast</span><span style="color:#c0c5ce;"><std::string>(req.</span><span style="color:#bf616a;">user_data</span><span style="color:#c0c5ce;">.</span><span style="color:#8fa1b3;">at</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">auth_user</span><span style="color:#c0c5ce;">"));
|
||||
</span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_content</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">Hello, </span><span style="color:#c0c5ce;">" + user, "</span><span style="color:#a3be8c;">text/plain</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">svr.set_pre_routing_handler([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">auto &</span><span style="color:#323232;">res) {
|
||||
@@ -359,15 +361,15 @@
|
||||
</span></pre>
|
||||
</div></div>
|
||||
<p>You can also customize error and exception handlers.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">set_error_handler</span><span style="color:#d3d0c8;">([](</span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&req, </span><span style="color:#cc99cc;">auto </span><span style="color:#d3d0c8;">&res) {
|
||||
</span><span style="color:#d3d0c8;"> res.</span><span style="color:#6699cc;">set_content</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">Custom Error Page</span><span style="color:#d3d0c8;">", "</span><span style="color:#99cc99;">text/html</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">set_exception_handler</span><span style="color:#d3d0c8;">([](</span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&req, </span><span style="color:#cc99cc;">auto </span><span style="color:#d3d0c8;">&res, std::exception_ptr ep) {
|
||||
</span><span style="color:#d3d0c8;"> res.</span><span style="color:#f2777a;">status </span><span style="color:#d3d0c8;">= </span><span style="color:#f99157;">500</span><span style="color:#d3d0c8;">;
|
||||
</span><span style="color:#d3d0c8;"> res.</span><span style="color:#6699cc;">set_content</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">Internal Server Error</span><span style="color:#d3d0c8;">", "</span><span style="color:#99cc99;">text/plain</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">set_error_handler</span><span style="color:#c0c5ce;">([](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&res) {
|
||||
</span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_content</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">Custom Error Page</span><span style="color:#c0c5ce;">", "</span><span style="color:#a3be8c;">text/html</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">set_exception_handler</span><span style="color:#c0c5ce;">([](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&res, std::exception_ptr ep) {
|
||||
</span><span style="color:#c0c5ce;"> res.</span><span style="color:#bf616a;">status </span><span style="color:#c0c5ce;">= </span><span style="color:#d08770;">500</span><span style="color:#c0c5ce;">;
|
||||
</span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_content</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">Internal Server Error</span><span style="color:#c0c5ce;">", "</span><span style="color:#a3be8c;">text/plain</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">svr.set_error_handler([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">auto &</span><span style="color:#323232;">res) {
|
||||
@@ -382,10 +384,10 @@
|
||||
</div></div>
|
||||
<h2>Logging</h2>
|
||||
<p>You can set a logger on both the server and the client.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">set_logger</span><span style="color:#d3d0c8;">([](</span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&req, </span><span style="color:#cc99cc;">const auto </span><span style="color:#d3d0c8;">&res) {
|
||||
</span><span style="color:#d3d0c8;"> std::cout << req.</span><span style="color:#f2777a;">method </span><span style="color:#d3d0c8;"><< " " << req.</span><span style="color:#f2777a;">path </span><span style="color:#d3d0c8;"><< " " << res.</span><span style="color:#f2777a;">status </span><span style="color:#d3d0c8;"><< std::endl;
|
||||
</span><span style="color:#d3d0c8;">});
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">set_logger</span><span style="color:#c0c5ce;">([](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&req, </span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&res) {
|
||||
</span><span style="color:#c0c5ce;"> std::cout << req.</span><span style="color:#bf616a;">method </span><span style="color:#c0c5ce;"><< " " << req.</span><span style="color:#bf616a;">path </span><span style="color:#c0c5ce;"><< " " << res.</span><span style="color:#bf616a;">status </span><span style="color:#c0c5ce;"><< std::endl;
|
||||
</span><span style="color:#c0c5ce;">});
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="color:#323232;">svr.set_logger([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">const auto &</span><span style="color:#323232;">res) {
|
||||
@@ -395,11 +397,11 @@
|
||||
</div></div>
|
||||
<h2>Unix Domain Socket</h2>
|
||||
<p>In addition to TCP, we support Unix Domain Sockets. You can use them for inter-process communication on the same machine.</p>
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#747369;">// Server
|
||||
</span><span style="color:#d3d0c8;">httplib::Server svr;
|
||||
</span><span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">set_address_family</span><span style="color:#d3d0c8;">(AF_UNIX);
|
||||
</span><span style="color:#d3d0c8;">svr.</span><span style="color:#6699cc;">listen</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">/tmp/httplib.sock</span><span style="color:#d3d0c8;">", </span><span style="color:#f99157;">0</span><span style="color:#d3d0c8;">);
|
||||
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#65737e;">// Server
|
||||
</span><span style="color:#c0c5ce;">httplib::Server svr;
|
||||
</span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">set_address_family</span><span style="color:#c0c5ce;">(AF_UNIX);
|
||||
</span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">listen</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">/tmp/httplib.sock</span><span style="color:#c0c5ce;">", </span><span style="color:#d08770;">0</span><span style="color:#c0c5ce;">);
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="font-style:italic;color:#969896;">// Server
|
||||
@@ -407,13 +409,13 @@
|
||||
</span><span style="color:#323232;">svr.set_address_family(AF_UNIX);
|
||||
</span><span style="color:#323232;">svr.listen(</span><span style="color:#183691;">"/tmp/httplib.sock"</span><span style="color:#323232;">, </span><span style="color:#0086b3;">0</span><span style="color:#323232;">);
|
||||
</span></pre>
|
||||
</div></div><div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2d2d2d;">
|
||||
<span style="color:#747369;">// Client
|
||||
</span><span style="color:#d3d0c8;">httplib::Client </span><span style="color:#6699cc;">cli</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">http://localhost</span><span style="color:#d3d0c8;">");
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_address_family</span><span style="color:#d3d0c8;">(AF_UNIX);
|
||||
</span><span style="color:#d3d0c8;">cli.</span><span style="color:#6699cc;">set_hostname_addr_map</span><span style="color:#d3d0c8;">({{"</span><span style="color:#99cc99;">localhost</span><span style="color:#d3d0c8;">", "</span><span style="color:#99cc99;">/tmp/httplib.sock</span><span style="color:#d3d0c8;">"}});
|
||||
</span><span style="color:#d3d0c8;">
|
||||
</span><span style="color:#cc99cc;">auto</span><span style="color:#d3d0c8;"> res = cli.</span><span style="color:#6699cc;">Get</span><span style="color:#d3d0c8;">("</span><span style="color:#99cc99;">/</span><span style="color:#d3d0c8;">");
|
||||
</div></div><div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
||||
<span style="color:#65737e;">// Client
|
||||
</span><span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">http://localhost</span><span style="color:#c0c5ce;">");
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_address_family</span><span style="color:#c0c5ce;">(AF_UNIX);
|
||||
</span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_hostname_addr_map</span><span style="color:#c0c5ce;">({{"</span><span style="color:#a3be8c;">localhost</span><span style="color:#c0c5ce;">", "</span><span style="color:#a3be8c;">/tmp/httplib.sock</span><span style="color:#c0c5ce;">"}});
|
||||
</span><span style="color:#c0c5ce;">
|
||||
</span><span style="color:#b48ead;">auto</span><span style="color:#c0c5ce;"> res = cli.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">/</span><span style="color:#c0c5ce;">");
|
||||
</span></pre>
|
||||
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
||||
<span style="font-style:italic;color:#969896;">// Client
|
||||
@@ -440,7 +442,7 @@
|
||||
</div>
|
||||
|
||||
<footer class="footer">
|
||||
© 2026 yhirose. All rights reserved.
|
||||
© 2026 Yuji Hirose. All rights reserved.
|
||||
</footer>
|
||||
|
||||
<!-- Search modal -->
|
||||
|
||||
Reference in New Issue
Block a user