index.html 49 KB

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