1
0

index.html 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462
  1. <!DOCTYPE html>
  2. <html lang="en" data-base-path="&#x2F;cpp-httplib">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <title>What&#x27;s Next - cpp-httplib</title>
  7. <link rel="icon" type="image/svg+xml" href="&#x2F;cpp-httplib/favicon.svg">
  8. <link rel="stylesheet" href="&#x2F;cpp-httplib/css/main.css">
  9. <script>
  10. (function() {
  11. var t = localStorage.getItem('preferred-theme');
  12. if (!t) t = window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark';
  13. if (t === 'light') document.documentElement.setAttribute('data-theme', 'light');
  14. })();
  15. </script>
  16. </head>
  17. <body>
  18. <header class="header">
  19. <div class="header-inner">
  20. <a href="&#x2F;cpp-httplib&#x2F;en/" class="header-title">cpp-httplib <span style="font-size:0.75em;font-weight:normal;margin-left:4px">v0.36.0</span></a>
  21. <div class="header-spacer"></div>
  22. <nav class="header-nav">
  23. <a href="&#x2F;cpp-httplib&#x2F;en/">
  24. <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>
  25. Home
  26. </a>
  27. <a href="&#x2F;cpp-httplib&#x2F;en/tour&#x2F;">
  28. <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>
  29. Tour
  30. </a>
  31. <a href="https:&#x2F;&#x2F;github.com&#x2F;yhirose&#x2F;cpp-httplib" aria-label="GitHub">
  32. <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"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"/></svg>
  33. GitHub
  34. </a>
  35. </nav>
  36. <div class="header-tools">
  37. <button class="search-btn" aria-label="Search (⌘K)">
  38. <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>
  39. </button>
  40. <button class="theme-toggle" aria-label="Toggle theme"></button>
  41. <div class="lang-selector">
  42. <button class="lang-btn" aria-label="Language">
  43. <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>
  44. EN
  45. </button>
  46. <ul class="lang-popup">
  47. <li><a href="#" data-lang="en">EN</a></li>
  48. <li><a href="#" data-lang="ja">JA</a></li>
  49. </ul>
  50. </div>
  51. </div>
  52. <button class="sidebar-toggle" aria-label="Menu">&#9776;</button>
  53. </div>
  54. </header>
  55. <div class="layout has-sidebar">
  56. <aside class="sidebar">
  57. <nav class="sidebar-nav">
  58. <div class="nav-section">
  59. <a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;" class="nav-section-title active">A Tour of cpp-httplib</a>
  60. <ul class="nav-list">
  61. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;01-getting-started&#x2F;" class="">Getting Started</a></li>
  62. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;02-basic-client&#x2F;" class="">Basic Client</a></li>
  63. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;03-basic-server&#x2F;" class="">Basic Server</a></li>
  64. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;04-static-file-server&#x2F;" class="">Static File Server</a></li>
  65. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;05-tls-setup&#x2F;" class="">TLS Setup</a></li>
  66. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;06-https-client&#x2F;" class="">HTTPS Client</a></li>
  67. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;07-https-server&#x2F;" class="">HTTPS Server</a></li>
  68. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;08-websocket&#x2F;" class="">WebSocket</a></li>
  69. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;09-whats-next&#x2F;" class="active">What&#x27;s Next</a></li>
  70. </ul>
  71. </div>
  72. </nav>
  73. </aside>
  74. <main class="content">
  75. <article>
  76. <h1>What&#x27;s Next</h1>
  77. <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>
  78. <h2>Streaming API</h2>
  79. <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>
  80. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  81. <span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">http://localhost:11434</span><span style="color:#c0c5ce;">&quot;);
  82. </span><span style="color:#c0c5ce;">
  83. </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, &quot;</span><span style="color:#a3be8c;">/api/generate</span><span style="color:#c0c5ce;">&quot;);
  84. </span><span style="color:#c0c5ce;">
  85. </span><span style="color:#b48ead;">if </span><span style="color:#c0c5ce;">(result) {
  86. </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;">()) {
  87. </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;">());
  88. </span><span style="color:#c0c5ce;"> }
  89. </span><span style="color:#c0c5ce;">}
  90. </span></pre>
  91. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  92. <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;">&quot;http://localhost:11434&quot;</span><span style="color:#323232;">);
  93. </span><span style="color:#323232;">
  94. </span><span style="font-weight:bold;color:#a71d5d;">auto</span><span style="color:#323232;"> result </span><span style="font-weight:bold;color:#a71d5d;">= </span><span style="color:#323232;">httplib::stream::Get(cli, </span><span style="color:#183691;">&quot;/api/generate&quot;</span><span style="color:#323232;">);
  95. </span><span style="color:#323232;">
  96. </span><span style="font-weight:bold;color:#a71d5d;">if </span><span style="color:#323232;">(result) {
  97. </span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">while </span><span style="color:#323232;">(result.next()) {
  98. </span><span style="color:#323232;"> std::cout.write(result.data(), result.size());
  99. </span><span style="color:#323232;"> }
  100. </span><span style="color:#323232;">}
  101. </span></pre>
  102. </div></div>
  103. <p>You can also pass a <code>content_receiver</code> callback to <code>Get()</code>. This approach works with Keep-Alive.</p>
  104. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  105. <span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">http://localhost:8080</span><span style="color:#c0c5ce;">&quot;);
  106. </span><span style="color:#c0c5ce;">
  107. </span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">/stream</span><span style="color:#c0c5ce;">&quot;, [](</span><span style="color:#b48ead;">const char </span><span style="color:#c0c5ce;">*data, size_t len) {
  108. </span><span style="color:#c0c5ce;"> std::cout.</span><span style="color:#8fa1b3;">write</span><span style="color:#c0c5ce;">(data, len);
  109. </span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">return </span><span style="color:#d08770;">true</span><span style="color:#c0c5ce;">;
  110. </span><span style="color:#c0c5ce;">});
  111. </span></pre>
  112. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  113. <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;">&quot;http://localhost:8080&quot;</span><span style="color:#323232;">);
  114. </span><span style="color:#323232;">
  115. </span><span style="color:#323232;">cli.Get(</span><span style="color:#183691;">&quot;/stream&quot;</span><span style="color:#323232;">, [](</span><span style="font-weight:bold;color:#a71d5d;">const char *</span><span style="color:#323232;">data, </span><span style="color:#0086b3;">size_t</span><span style="color:#323232;"> len) {
  116. </span><span style="color:#323232;"> std::cout.write(data, len);
  117. </span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">return </span><span style="color:#0086b3;">true</span><span style="color:#323232;">;
  118. </span><span style="color:#323232;">});
  119. </span></pre>
  120. </div></div>
  121. <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>
  122. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  123. <span style="color:#65737e;">// With known size (sets Content-Length)
  124. </span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">/file</span><span style="color:#c0c5ce;">&quot;, [](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&amp;, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&amp;res) {
  125. </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;">(&quot;</span><span style="color:#a3be8c;">large.bin</span><span style="color:#c0c5ce;">&quot;);
  126. </span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_content_provider</span><span style="color:#c0c5ce;">(size, &quot;</span><span style="color:#a3be8c;">application/octet-stream</span><span style="color:#c0c5ce;">&quot;,
  127. </span><span style="color:#c0c5ce;"> [](size_t offset, size_t length, httplib::DataSink &amp;sink) {
  128. </span><span style="color:#c0c5ce;"> </span><span style="color:#65737e;">// Send &#39;length&#39; bytes starting from &#39;offset&#39;
  129. </span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">return </span><span style="color:#d08770;">true</span><span style="color:#c0c5ce;">;
  130. </span><span style="color:#c0c5ce;"> });
  131. </span><span style="color:#c0c5ce;">});
  132. </span><span style="color:#c0c5ce;">
  133. </span><span style="color:#65737e;">// Unknown size (Chunked Transfer Encoding)
  134. </span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">/stream</span><span style="color:#c0c5ce;">&quot;, [](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&amp;, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&amp;res) {
  135. </span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_chunked_content_provider</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">text/plain</span><span style="color:#c0c5ce;">&quot;,
  136. </span><span style="color:#c0c5ce;"> [](size_t offset, httplib::DataSink &amp;sink) {
  137. </span><span style="color:#c0c5ce;"> sink.</span><span style="color:#8fa1b3;">write</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">chunk</span><span style="color:#96b5b4;">\n</span><span style="color:#c0c5ce;">&quot;, </span><span style="color:#d08770;">6</span><span style="color:#c0c5ce;">);
  138. </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
  139. </span><span style="color:#c0c5ce;"> });
  140. </span><span style="color:#c0c5ce;">});
  141. </span></pre>
  142. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  143. <span style="font-style:italic;color:#969896;">// With known size (sets Content-Length)
  144. </span><span style="color:#323232;">svr.Get(</span><span style="color:#183691;">&quot;/file&quot;</span><span style="color:#323232;">, [](</span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">, </span><span style="font-weight:bold;color:#a71d5d;">auto &amp;</span><span style="color:#323232;">res) {
  145. </span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">auto</span><span style="color:#323232;"> size </span><span style="font-weight:bold;color:#a71d5d;">= </span><span style="color:#323232;">get_file_size(</span><span style="color:#183691;">&quot;large.bin&quot;</span><span style="color:#323232;">);
  146. </span><span style="color:#323232;"> res.set_content_provider(size, </span><span style="color:#183691;">&quot;application/octet-stream&quot;</span><span style="color:#323232;">,
  147. </span><span style="color:#323232;"> [](</span><span style="color:#0086b3;">size_t</span><span style="color:#323232;"> offset, </span><span style="color:#0086b3;">size_t</span><span style="color:#323232;"> length, httplib::DataSink </span><span style="font-weight:bold;color:#a71d5d;">&amp;</span><span style="color:#323232;">sink) {
  148. </span><span style="color:#323232;"> </span><span style="font-style:italic;color:#969896;">// Send &#39;length&#39; bytes starting from &#39;offset&#39;
  149. </span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">return </span><span style="color:#0086b3;">true</span><span style="color:#323232;">;
  150. </span><span style="color:#323232;"> });
  151. </span><span style="color:#323232;">});
  152. </span><span style="color:#323232;">
  153. </span><span style="font-style:italic;color:#969896;">// Unknown size (Chunked Transfer Encoding)
  154. </span><span style="color:#323232;">svr.Get(</span><span style="color:#183691;">&quot;/stream&quot;</span><span style="color:#323232;">, [](</span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">, </span><span style="font-weight:bold;color:#a71d5d;">auto &amp;</span><span style="color:#323232;">res) {
  155. </span><span style="color:#323232;"> res.set_chunked_content_provider(</span><span style="color:#183691;">&quot;text/plain&quot;</span><span style="color:#323232;">,
  156. </span><span style="color:#323232;"> [](</span><span style="color:#0086b3;">size_t</span><span style="color:#323232;"> offset, httplib::DataSink </span><span style="font-weight:bold;color:#a71d5d;">&amp;</span><span style="color:#323232;">sink) {
  157. </span><span style="color:#323232;"> sink.write(</span><span style="color:#183691;">&quot;chunk</span><span style="color:#0086b3;">\n</span><span style="color:#183691;">&quot;</span><span style="color:#323232;">, </span><span style="color:#0086b3;">6</span><span style="color:#323232;">);
  158. </span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">return </span><span style="color:#0086b3;">true</span><span style="color:#323232;">; </span><span style="font-style:italic;color:#969896;">// Return false to finish
  159. </span><span style="color:#323232;"> });
  160. </span><span style="color:#323232;">});
  161. </span></pre>
  162. </div></div>
  163. <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>
  164. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  165. <span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">http://localhost:8080</span><span style="color:#c0c5ce;">&quot;);
  166. </span><span style="color:#c0c5ce;">
  167. </span><span style="color:#b48ead;">auto</span><span style="color:#c0c5ce;"> res = cli.</span><span style="color:#8fa1b3;">Post</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">/upload</span><span style="color:#c0c5ce;">&quot;, {}, {
  168. </span><span style="color:#c0c5ce;"> </span><span style="color:#8fa1b3;">httplib::make_file_provider</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">file</span><span style="color:#c0c5ce;">&quot;, &quot;</span><span style="color:#a3be8c;">/path/to/large-file.zip</span><span style="color:#c0c5ce;">&quot;)
  169. </span><span style="color:#c0c5ce;">});
  170. </span></pre>
  171. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  172. <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;">&quot;http://localhost:8080&quot;</span><span style="color:#323232;">);
  173. </span><span style="color:#323232;">
  174. </span><span style="font-weight:bold;color:#a71d5d;">auto</span><span style="color:#323232;"> res </span><span style="font-weight:bold;color:#a71d5d;">=</span><span style="color:#323232;"> cli.Post(</span><span style="color:#183691;">&quot;/upload&quot;</span><span style="color:#323232;">, {}, {
  175. </span><span style="color:#323232;"> httplib::make_file_provider(</span><span style="color:#183691;">&quot;file&quot;</span><span style="color:#323232;">, </span><span style="color:#183691;">&quot;/path/to/large-file.zip&quot;</span><span style="color:#323232;">)
  176. </span><span style="color:#323232;">});
  177. </span></pre>
  178. </div></div>
  179. <h2>Server-Sent Events (SSE)</h2>
  180. <p>We provide an SSE client as well. It supports automatic reconnection and resuming via <code>Last-Event-ID</code>.</p>
  181. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  182. <span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">http://localhost:8080</span><span style="color:#c0c5ce;">&quot;);
  183. </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;">, &quot;</span><span style="color:#a3be8c;">/events</span><span style="color:#c0c5ce;">&quot;);
  184. </span><span style="color:#c0c5ce;">
  185. </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 &amp;msg) {
  186. </span><span style="color:#c0c5ce;"> std::cout &lt;&lt; msg.</span><span style="color:#bf616a;">event </span><span style="color:#c0c5ce;">&lt;&lt; &quot;</span><span style="color:#a3be8c;">: </span><span style="color:#c0c5ce;">&quot; &lt;&lt; msg.</span><span style="color:#bf616a;">data </span><span style="color:#c0c5ce;">&lt;&lt; std::endl;
  187. </span><span style="color:#c0c5ce;">});
  188. </span><span style="color:#c0c5ce;">
  189. </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
  190. </span></pre>
  191. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  192. <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;">&quot;http://localhost:8080&quot;</span><span style="color:#323232;">);
  193. </span><span style="color:#323232;">httplib::sse::SSEClient </span><span style="font-weight:bold;color:#795da3;">sse</span><span style="color:#323232;">(cli, </span><span style="color:#183691;">&quot;/events&quot;</span><span style="color:#323232;">);
  194. </span><span style="color:#323232;">
  195. </span><span style="color:#323232;">sse.on_message([](</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;">&amp;</span><span style="color:#323232;">msg) {
  196. </span><span style="color:#323232;"> std::cout </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt;</span><span style="color:#323232;"> msg.event </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt; </span><span style="color:#183691;">&quot;: &quot; </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt;</span><span style="color:#323232;"> msg.data </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt;</span><span style="color:#323232;"> std::endl;
  197. </span><span style="color:#323232;">});
  198. </span><span style="color:#323232;">
  199. </span><span style="color:#323232;">sse.start(); </span><span style="font-style:italic;color:#969896;">// Blocking, with auto-reconnection
  200. </span></pre>
  201. </div></div>
  202. <p>You can also set separate handlers for each event type.</p>
  203. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  204. <span style="color:#c0c5ce;">sse.</span><span style="color:#8fa1b3;">on_event</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">update</span><span style="color:#c0c5ce;">&quot;, [](</span><span style="color:#b48ead;">const</span><span style="color:#c0c5ce;"> httplib::sse::SSEMessage &amp;msg) {
  205. </span><span style="color:#c0c5ce;"> </span><span style="color:#65737e;">// Only handles &quot;update&quot; events
  206. </span><span style="color:#c0c5ce;">});
  207. </span></pre>
  208. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  209. <span style="color:#323232;">sse.on_event(</span><span style="color:#183691;">&quot;update&quot;</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;">&amp;</span><span style="color:#323232;">msg) {
  210. </span><span style="color:#323232;"> </span><span style="font-style:italic;color:#969896;">// Only handles &quot;update&quot; events
  211. </span><span style="color:#323232;">});
  212. </span></pre>
  213. </div></div>
  214. <h2>Authentication</h2>
  215. <p>The client has helpers for Basic auth, Bearer Token auth, and Digest auth.</p>
  216. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  217. <span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">https://api.example.com</span><span style="color:#c0c5ce;">&quot;);
  218. </span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_basic_auth</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">user</span><span style="color:#c0c5ce;">&quot;, &quot;</span><span style="color:#a3be8c;">password</span><span style="color:#c0c5ce;">&quot;);
  219. </span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_bearer_token_auth</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">my-token</span><span style="color:#c0c5ce;">&quot;);
  220. </span></pre>
  221. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  222. <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;">&quot;https://api.example.com&quot;</span><span style="color:#323232;">);
  223. </span><span style="color:#323232;">cli.set_basic_auth(</span><span style="color:#183691;">&quot;user&quot;</span><span style="color:#323232;">, </span><span style="color:#183691;">&quot;password&quot;</span><span style="color:#323232;">);
  224. </span><span style="color:#323232;">cli.set_bearer_token_auth(</span><span style="color:#183691;">&quot;my-token&quot;</span><span style="color:#323232;">);
  225. </span></pre>
  226. </div></div>
  227. <h2>Compression</h2>
  228. <p>We support compression and decompression with gzip, Brotli, and Zstandard. Define the corresponding macro when you compile.</p>
  229. <table><thead><tr><th>Method</th><th>Macro</th></tr></thead><tbody>
  230. <tr><td>gzip</td><td><code>CPPHTTPLIB_ZLIB_SUPPORT</code></td></tr>
  231. <tr><td>Brotli</td><td><code>CPPHTTPLIB_BROTLI_SUPPORT</code></td></tr>
  232. <tr><td>Zstandard</td><td><code>CPPHTTPLIB_ZSTD_SUPPORT</code></td></tr>
  233. </tbody></table>
  234. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  235. <span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">https://example.com</span><span style="color:#c0c5ce;">&quot;);
  236. </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
  237. </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
  238. </span></pre>
  239. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  240. <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;">&quot;https://example.com&quot;</span><span style="color:#323232;">);
  241. </span><span style="color:#323232;">cli.set_compress(</span><span style="color:#0086b3;">true</span><span style="color:#323232;">); </span><span style="font-style:italic;color:#969896;">// Compress request body
  242. </span><span style="color:#323232;">cli.set_decompress(</span><span style="color:#0086b3;">true</span><span style="color:#323232;">); </span><span style="font-style:italic;color:#969896;">// Decompress response body
  243. </span></pre>
  244. </div></div>
  245. <h2>Proxy</h2>
  246. <p>You can connect through an HTTP proxy.</p>
  247. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  248. <span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">https://example.com</span><span style="color:#c0c5ce;">&quot;);
  249. </span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_proxy</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">proxy.example.com</span><span style="color:#c0c5ce;">&quot;, </span><span style="color:#d08770;">8080</span><span style="color:#c0c5ce;">);
  250. </span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_proxy_basic_auth</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">user</span><span style="color:#c0c5ce;">&quot;, &quot;</span><span style="color:#a3be8c;">password</span><span style="color:#c0c5ce;">&quot;);
  251. </span></pre>
  252. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  253. <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;">&quot;https://example.com&quot;</span><span style="color:#323232;">);
  254. </span><span style="color:#323232;">cli.set_proxy(</span><span style="color:#183691;">&quot;proxy.example.com&quot;</span><span style="color:#323232;">, </span><span style="color:#0086b3;">8080</span><span style="color:#323232;">);
  255. </span><span style="color:#323232;">cli.set_proxy_basic_auth(</span><span style="color:#183691;">&quot;user&quot;</span><span style="color:#323232;">, </span><span style="color:#183691;">&quot;password&quot;</span><span style="color:#323232;">);
  256. </span></pre>
  257. </div></div>
  258. <h2>Timeouts</h2>
  259. <p>You can set connection, read, and write timeouts individually.</p>
  260. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  261. <span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">https://example.com</span><span style="color:#c0c5ce;">&quot;);
  262. </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
  263. </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
  264. </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
  265. </span></pre>
  266. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  267. <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;">&quot;https://example.com&quot;</span><span style="color:#323232;">);
  268. </span><span style="color:#323232;">cli.set_connection_timeout(</span><span style="color:#0086b3;">5</span><span style="color:#323232;">, </span><span style="color:#0086b3;">0</span><span style="color:#323232;">); </span><span style="font-style:italic;color:#969896;">// 5 seconds
  269. </span><span style="color:#323232;">cli.set_read_timeout(</span><span style="color:#0086b3;">10</span><span style="color:#323232;">, </span><span style="color:#0086b3;">0</span><span style="color:#323232;">); </span><span style="font-style:italic;color:#969896;">// 10 seconds
  270. </span><span style="color:#323232;">cli.set_write_timeout(</span><span style="color:#0086b3;">10</span><span style="color:#323232;">, </span><span style="color:#0086b3;">0</span><span style="color:#323232;">); </span><span style="font-style:italic;color:#969896;">// 10 seconds
  271. </span></pre>
  272. </div></div>
  273. <h2>Keep-Alive</h2>
  274. <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>
  275. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  276. <span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">https://example.com</span><span style="color:#c0c5ce;">&quot;);
  277. </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;">);
  278. </span></pre>
  279. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  280. <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;">&quot;https://example.com&quot;</span><span style="color:#323232;">);
  281. </span><span style="color:#323232;">cli.set_keep_alive(</span><span style="color:#0086b3;">true</span><span style="color:#323232;">);
  282. </span></pre>
  283. </div></div>
  284. <h2>Server Middleware</h2>
  285. <p>You can hook into request processing before and after handlers run.</p>
  286. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  287. <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;">&amp;req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&amp;res) {
  288. </span><span style="color:#c0c5ce;"> </span><span style="color:#65737e;">// Runs before every request
  289. </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
  290. </span><span style="color:#c0c5ce;">});
  291. </span><span style="color:#c0c5ce;">
  292. </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;">&amp;req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&amp;res) {
  293. </span><span style="color:#c0c5ce;"> </span><span style="color:#65737e;">// Runs after the response is sent
  294. </span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_header</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">X-Server</span><span style="color:#c0c5ce;">&quot;, &quot;</span><span style="color:#a3be8c;">cpp-httplib</span><span style="color:#c0c5ce;">&quot;);
  295. </span><span style="color:#c0c5ce;">});
  296. </span></pre>
  297. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  298. <span style="color:#323232;">svr.set_pre_routing_handler([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">auto &amp;</span><span style="color:#323232;">res) {
  299. </span><span style="color:#323232;"> </span><span style="font-style:italic;color:#969896;">// Runs before every request
  300. </span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">return</span><span style="color:#323232;"> httplib::Server::HandlerResponse::Unhandled; </span><span style="font-style:italic;color:#969896;">// Continue to normal routing
  301. </span><span style="color:#323232;">});
  302. </span><span style="color:#323232;">
  303. </span><span style="color:#323232;">svr.set_post_routing_handler([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">auto &amp;</span><span style="color:#323232;">res) {
  304. </span><span style="color:#323232;"> </span><span style="font-style:italic;color:#969896;">// Runs after the response is sent
  305. </span><span style="color:#323232;"> res.set_header(</span><span style="color:#183691;">&quot;X-Server&quot;</span><span style="color:#323232;">, </span><span style="color:#183691;">&quot;cpp-httplib&quot;</span><span style="color:#323232;">);
  306. </span><span style="color:#323232;">});
  307. </span></pre>
  308. </div></div>
  309. <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>
  310. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  311. <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;">&amp;req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&amp;res) {
  312. </span><span style="color:#c0c5ce;"> req.</span><span style="color:#bf616a;">user_data</span><span style="color:#c0c5ce;">[&quot;</span><span style="color:#a3be8c;">auth_user</span><span style="color:#c0c5ce;">&quot;] = </span><span style="color:#8fa1b3;">std::string</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">alice</span><span style="color:#c0c5ce;">&quot;);
  313. </span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">return</span><span style="color:#c0c5ce;"> httplib::Server::HandlerResponse::Unhandled;
  314. </span><span style="color:#c0c5ce;">});
  315. </span><span style="color:#c0c5ce;">
  316. </span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">/me</span><span style="color:#c0c5ce;">&quot;, [](</span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&amp;req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&amp;res) {
  317. </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;">&lt;std::string&gt;(req.</span><span style="color:#bf616a;">user_data</span><span style="color:#c0c5ce;">.</span><span style="color:#8fa1b3;">at</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">auth_user</span><span style="color:#c0c5ce;">&quot;));
  318. </span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_content</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">Hello, </span><span style="color:#c0c5ce;">&quot; + user, &quot;</span><span style="color:#a3be8c;">text/plain</span><span style="color:#c0c5ce;">&quot;);
  319. </span><span style="color:#c0c5ce;">});
  320. </span></pre>
  321. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  322. <span style="color:#323232;">svr.set_pre_routing_handler([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">auto &amp;</span><span style="color:#323232;">res) {
  323. </span><span style="color:#323232;"> req.user_data[</span><span style="color:#183691;">&quot;auth_user&quot;</span><span style="color:#323232;">] </span><span style="font-weight:bold;color:#a71d5d;">= </span><span style="color:#323232;">std::string(</span><span style="color:#183691;">&quot;alice&quot;</span><span style="color:#323232;">);
  324. </span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">return</span><span style="color:#323232;"> httplib::Server::HandlerResponse::Unhandled;
  325. </span><span style="color:#323232;">});
  326. </span><span style="color:#323232;">
  327. </span><span style="color:#323232;">svr.Get(</span><span style="color:#183691;">&quot;/me&quot;</span><span style="color:#323232;">, [](</span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">auto &amp;</span><span style="color:#323232;">res) {
  328. </span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">auto</span><span style="color:#323232;"> user </span><span style="font-weight:bold;color:#a71d5d;">= </span><span style="color:#323232;">std::any_cast&lt;std::string&gt;(req.user_data.at(</span><span style="color:#183691;">&quot;auth_user&quot;</span><span style="color:#323232;">));
  329. </span><span style="color:#323232;"> res.set_content(</span><span style="color:#183691;">&quot;Hello, &quot; </span><span style="font-weight:bold;color:#a71d5d;">+</span><span style="color:#323232;"> user, </span><span style="color:#183691;">&quot;text/plain&quot;</span><span style="color:#323232;">);
  330. </span><span style="color:#323232;">});
  331. </span></pre>
  332. </div></div>
  333. <p>You can also customize error and exception handlers.</p>
  334. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  335. <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;">&amp;req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&amp;res) {
  336. </span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_content</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">Custom Error Page</span><span style="color:#c0c5ce;">&quot;, &quot;</span><span style="color:#a3be8c;">text/html</span><span style="color:#c0c5ce;">&quot;);
  337. </span><span style="color:#c0c5ce;">});
  338. </span><span style="color:#c0c5ce;">
  339. </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;">&amp;req, </span><span style="color:#b48ead;">auto </span><span style="color:#c0c5ce;">&amp;res, std::exception_ptr ep) {
  340. </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;">;
  341. </span><span style="color:#c0c5ce;"> res.</span><span style="color:#8fa1b3;">set_content</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">Internal Server Error</span><span style="color:#c0c5ce;">&quot;, &quot;</span><span style="color:#a3be8c;">text/plain</span><span style="color:#c0c5ce;">&quot;);
  342. </span><span style="color:#c0c5ce;">});
  343. </span></pre>
  344. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  345. <span style="color:#323232;">svr.set_error_handler([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">auto &amp;</span><span style="color:#323232;">res) {
  346. </span><span style="color:#323232;"> res.set_content(</span><span style="color:#183691;">&quot;Custom Error Page&quot;</span><span style="color:#323232;">, </span><span style="color:#183691;">&quot;text/html&quot;</span><span style="color:#323232;">);
  347. </span><span style="color:#323232;">});
  348. </span><span style="color:#323232;">
  349. </span><span style="color:#323232;">svr.set_exception_handler([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">auto &amp;</span><span style="color:#323232;">res, std::exception_ptr ep) {
  350. </span><span style="color:#323232;"> res.status </span><span style="font-weight:bold;color:#a71d5d;">= </span><span style="color:#0086b3;">500</span><span style="color:#323232;">;
  351. </span><span style="color:#323232;"> res.set_content(</span><span style="color:#183691;">&quot;Internal Server Error&quot;</span><span style="color:#323232;">, </span><span style="color:#183691;">&quot;text/plain&quot;</span><span style="color:#323232;">);
  352. </span><span style="color:#323232;">});
  353. </span></pre>
  354. </div></div>
  355. <h2>Logging</h2>
  356. <p>You can set a logger on both the server and the client.</p>
  357. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  358. <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;">&amp;req, </span><span style="color:#b48ead;">const auto </span><span style="color:#c0c5ce;">&amp;res) {
  359. </span><span style="color:#c0c5ce;"> std::cout &lt;&lt; req.</span><span style="color:#bf616a;">method </span><span style="color:#c0c5ce;">&lt;&lt; &quot; &quot; &lt;&lt; req.</span><span style="color:#bf616a;">path </span><span style="color:#c0c5ce;">&lt;&lt; &quot; &quot; &lt;&lt; res.</span><span style="color:#bf616a;">status </span><span style="color:#c0c5ce;">&lt;&lt; std::endl;
  360. </span><span style="color:#c0c5ce;">});
  361. </span></pre>
  362. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  363. <span style="color:#323232;">svr.set_logger([](</span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">req, </span><span style="font-weight:bold;color:#a71d5d;">const auto &amp;</span><span style="color:#323232;">res) {
  364. </span><span style="color:#323232;"> std::cout </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt;</span><span style="color:#323232;"> req.method </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt; </span><span style="color:#183691;">&quot; &quot; </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt;</span><span style="color:#323232;"> req.path </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt; </span><span style="color:#183691;">&quot; &quot; </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt;</span><span style="color:#323232;"> res.status </span><span style="font-weight:bold;color:#a71d5d;">&lt;&lt;</span><span style="color:#323232;"> std::endl;
  365. </span><span style="color:#323232;">});
  366. </span></pre>
  367. </div></div>
  368. <h2>Unix Domain Socket</h2>
  369. <p>In addition to TCP, we support Unix Domain Sockets. You can use them for inter-process communication on the same machine.</p>
  370. <div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  371. <span style="color:#65737e;">// Server
  372. </span><span style="color:#c0c5ce;">httplib::Server svr;
  373. </span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">set_address_family</span><span style="color:#c0c5ce;">(AF_UNIX);
  374. </span><span style="color:#c0c5ce;">svr.</span><span style="color:#8fa1b3;">listen</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">/tmp/httplib.sock</span><span style="color:#c0c5ce;">&quot;, </span><span style="color:#d08770;">0</span><span style="color:#c0c5ce;">);
  375. </span></pre>
  376. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  377. <span style="font-style:italic;color:#969896;">// Server
  378. </span><span style="color:#323232;">httplib::Server svr;
  379. </span><span style="color:#323232;">svr.set_address_family(AF_UNIX);
  380. </span><span style="color:#323232;">svr.listen(</span><span style="color:#183691;">&quot;/tmp/httplib.sock&quot;</span><span style="color:#323232;">, </span><span style="color:#0086b3;">0</span><span style="color:#323232;">);
  381. </span></pre>
  382. </div></div><div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
  383. <span style="color:#65737e;">// Client
  384. </span><span style="color:#c0c5ce;">httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">http://localhost</span><span style="color:#c0c5ce;">&quot;);
  385. </span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_address_family</span><span style="color:#c0c5ce;">(AF_UNIX);
  386. </span><span style="color:#c0c5ce;">cli.</span><span style="color:#8fa1b3;">set_hostname_addr_map</span><span style="color:#c0c5ce;">({{&quot;</span><span style="color:#a3be8c;">localhost</span><span style="color:#c0c5ce;">&quot;, &quot;</span><span style="color:#a3be8c;">/tmp/httplib.sock</span><span style="color:#c0c5ce;">&quot;}});
  387. </span><span style="color:#c0c5ce;">
  388. </span><span style="color:#b48ead;">auto</span><span style="color:#c0c5ce;"> res = cli.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">(&quot;</span><span style="color:#a3be8c;">/</span><span style="color:#c0c5ce;">&quot;);
  389. </span></pre>
  390. </div><div data-code-theme="light"><pre style="background-color:#ffffff;">
  391. <span style="font-style:italic;color:#969896;">// Client
  392. </span><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;">&quot;http://localhost&quot;</span><span style="color:#323232;">);
  393. </span><span style="color:#323232;">cli.set_address_family(AF_UNIX);
  394. </span><span style="color:#323232;">cli.set_hostname_addr_map({{</span><span style="color:#183691;">&quot;localhost&quot;</span><span style="color:#323232;">, </span><span style="color:#183691;">&quot;/tmp/httplib.sock&quot;</span><span style="color:#323232;">}});
  395. </span><span style="color:#323232;">
  396. </span><span style="font-weight:bold;color:#a71d5d;">auto</span><span style="color:#323232;"> res </span><span style="font-weight:bold;color:#a71d5d;">=</span><span style="color:#323232;"> cli.Get(</span><span style="color:#183691;">&quot;/&quot;</span><span style="color:#323232;">);
  397. </span></pre>
  398. </div></div>
  399. <h2>Learn More</h2>
  400. <p>Want to dig deeper? Check out these resources.</p>
  401. <ul>
  402. <li>Cookbook — A collection of recipes for common use cases</li>
  403. <li><a href="https://github.com/yhirose/cpp-httplib/blob/master/README.md">README</a> — Full API reference</li>
  404. <li><a href="https://github.com/yhirose/cpp-httplib/blob/master/README-sse.md">README-sse</a> — How to use Server-Sent Events</li>
  405. <li><a href="https://github.com/yhirose/cpp-httplib/blob/master/README-stream.md">README-stream</a> — How to use the Streaming API</li>
  406. <li><a href="https://github.com/yhirose/cpp-httplib/blob/master/README-websocket.md">README-websocket</a> — How to use the WebSocket server</li>
  407. </ul>
  408. </article>
  409. </main>
  410. </div>
  411. <footer class="footer">
  412. © 2026 Yuji Hirose. All rights reserved.
  413. </footer>
  414. <!-- Search modal -->
  415. <div class="search-overlay" id="search-overlay">
  416. <div class="search-modal">
  417. <div class="search-input-wrap">
  418. <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>
  419. <input type="text" id="search-input" placeholder="Search..." autocomplete="off" spellcheck="false">
  420. <kbd class="search-esc">ESC</kbd>
  421. </div>
  422. <ul class="search-results" id="search-results"></ul>
  423. </div>
  424. </div>
  425. <script src="&#x2F;cpp-httplib/js/main.js"></script>
  426. </body>
  427. </html>