index.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Chapter&#160;1.&#160;Boost.Beast</title>
  5. <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="index.html" title="Chapter&#160;1.&#160;Boost.Beast">
  8. <link rel="next" href="beast/quickref.html" title="Reference">
  9. </head>
  10. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  11. <table cellpadding="2" width="100%"><tr>
  12. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  13. <td align="center"><a href="../../../../index.html">Home</a></td>
  14. <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  15. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  16. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  17. <td align="center"><a href="../../../../more/index.htm">More</a></td>
  18. </tr></table>
  19. <hr>
  20. <div class="spirit-nav"><a accesskey="n" href="beast/quickref.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
  21. <div class="chapter">
  22. <div class="titlepage"><div>
  23. <div><h2 class="title">
  24. <a name="beast"></a>Chapter&#160;1.&#160;Boost.Beast</h2></div>
  25. <div><div class="author"><h3 class="author">
  26. <span class="firstname">Vinnie</span> <span class="surname">Falco</span>
  27. </h3></div></div>
  28. <div><p class="copyright">Copyright &#169; 2016-2019 Vinnie
  29. Falco</p></div>
  30. <div><div class="legalnotice">
  31. <a name="beast.legal"></a><p>
  32. Distributed under the Boost Software License, Version 1.0. (See accompanying
  33. file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  34. </p>
  35. </div></div>
  36. </div></div>
  37. <div class="toc">
  38. <p><b>Table of Contents</b></p>
  39. <dl class="toc">
  40. <dt><span class="section"><a href="beast/quickref.html">Reference</a></span></dt>
  41. <dt><span class="section"><a href="beast/release_notes.html">Release Notes</a></span></dt>
  42. <dt><span class="section"><a href="beast/introduction.html">Introduction</a></span></dt>
  43. <dd><dl>
  44. <dt><span class="section"><a href="beast/introduction.html#beast.introduction.requirements">Requirements</a></span></dt>
  45. <dt><span class="section"><a href="beast/introduction.html#beast.introduction.reporting_bugs">Reporting Bugs</a></span></dt>
  46. <dt><span class="section"><a href="beast/introduction.html#beast.introduction.credits">Credits</a></span></dt>
  47. </dl></dd>
  48. <dt><span class="section"><a href="beast/quick_start.html">Quick Look</a></span></dt>
  49. <dd><dl>
  50. <dt><span class="section"><a href="beast/quick_start/http_client.html">Simple HTTP Client &#128161;</a></span></dt>
  51. <dt><span class="section"><a href="beast/quick_start/websocket_client.html">Simple WebSocket
  52. Client &#128161;</a></span></dt>
  53. <dt><span class="section"><a href="beast/quick_start/security_review_bishop_fox.html">Security
  54. Review (Bishop Fox) &#127910;</a></span></dt>
  55. <dt><span class="section"><a href="beast/quick_start/websocket_autobahn_testsuite.html">WebSocket
  56. (Autobahn|Testsuite)</a></span></dt>
  57. </dl></dd>
  58. <dt><span class="section"><a href="beast/examples.html">Examples</a></span></dt>
  59. <dd><dl>
  60. <dt><span class="section"><a href="beast/examples.html#beast.examples.clients">Clients</a></span></dt>
  61. <dt><span class="section"><a href="beast/examples.html#beast.examples.servers">Servers</a></span></dt>
  62. <dt><span class="section"><a href="beast/examples.html#beast.examples.servers_advanced">Servers (Advanced)</a></span></dt>
  63. <dt><span class="section"><a href="beast/examples.html#beast.examples.chat_server">Chat Server &#127910;</a></span></dt>
  64. </dl></dd>
  65. <dt><span class="section"><a href="beast/using_io.html">Networking</a></span></dt>
  66. <dd><dl>
  67. <dt><span class="section"><a href="beast/using_io/asio_refresher.html">Refresher</a></span></dt>
  68. <dt><span class="section"><a href="beast/using_io/stream_types.html">Streams</a></span></dt>
  69. <dt><span class="section"><a href="beast/using_io/timeouts.html">Timeouts &#128161;</a></span></dt>
  70. <dt><span class="section"><a href="beast/using_io/rate_limiting.html">Rate Limiting &#128161;</a></span></dt>
  71. <dt><span class="section"><a href="beast/using_io/layered_streams.html">Layered Streams</a></span></dt>
  72. <dd><dl><dt><span class="section"><a href="beast/using_io/layered_streams/counted_stream_example.html">Counted
  73. Stream &#128161;</a></span></dt></dl></dd>
  74. <dt><span class="section"><a href="beast/using_io/buffer_types.html">Buffer Types</a></span></dt>
  75. <dt><span class="section"><a href="beast/using_io/files.html">Files</a></span></dt>
  76. <dt><span class="section"><a href="beast/using_io/writing_composed_operations.html">Writing Composed
  77. Operations</a></span></dt>
  78. <dd><dl>
  79. <dt><span class="section"><a href="beast/using_io/writing_composed_operations/echo.html">Echo
  80. &#128161;</a></span></dt>
  81. <dt><span class="section"><a href="beast/using_io/writing_composed_operations/detect_ssl.html">Detect
  82. SSL &#128161;</a></span></dt>
  83. </dl></dd>
  84. </dl></dd>
  85. <dt><span class="section"><a href="beast/using_http.html">HTTP</a></span></dt>
  86. <dd><dl>
  87. <dt><span class="section"><a href="beast/using_http/protocol_primer.html">Protocol Primer</a></span></dt>
  88. <dt><span class="section"><a href="beast/using_http/message_containers.html">Message Containers</a></span></dt>
  89. <dt><span class="section"><a href="beast/using_http/message_stream_operations.html">Message Stream
  90. Operations</a></span></dt>
  91. <dt><span class="section"><a href="beast/using_http/serializer_stream_operations.html">Serializer
  92. Stream Operations</a></span></dt>
  93. <dt><span class="section"><a href="beast/using_http/parser_stream_operations.html">Parser Stream
  94. Operations</a></span></dt>
  95. <dd><dl><dt><span class="section"><a href="beast/using_http/parser_stream_operations/incremental_read.html">Incremental
  96. Read &#128161;</a></span></dt></dl></dd>
  97. <dt><span class="section"><a href="beast/using_http/buffer_oriented_serializing.html">Buffer-Oriented
  98. Serializing</a></span></dt>
  99. <dd><dl><dt><span class="section"><a href="beast/using_http/buffer_oriented_serializing.html#beast.using_http.buffer_oriented_serializing.write_to_std_ostream">Write
  100. To std::ostream &#128161;</a></span></dt></dl></dd>
  101. <dt><span class="section"><a href="beast/using_http/buffer_oriented_parsing.html">Buffer-Oriented
  102. Parsing</a></span></dt>
  103. <dd><dl><dt><span class="section"><a href="beast/using_http/buffer_oriented_parsing.html#beast.using_http.buffer_oriented_parsing.read_from_std_istream">Read
  104. From std::istream &#128161;</a></span></dt></dl></dd>
  105. <dt><span class="section"><a href="beast/using_http/chunked_encoding.html">Chunked Encoding</a></span></dt>
  106. <dt><span class="section"><a href="beast/using_http/custom_body_types.html">Custom Body Types</a></span></dt>
  107. <dd><dl><dt><span class="section"><a href="beast/using_http/custom_body_types.html#beast.using_http.custom_body_types.file_body">File
  108. Body &#128161;</a></span></dt></dl></dd>
  109. <dt><span class="section"><a href="beast/using_http/custom_parsers.html">Custom Parsers</a></span></dt>
  110. </dl></dd>
  111. <dt><span class="section"><a href="beast/more_examples.html">HTTP Examples</a></span></dt>
  112. <dd><dl>
  113. <dt><span class="section"><a href="beast/more_examples/change_body_type.html">Change Body Type
  114. &#128161;</a></span></dt>
  115. <dt><span class="section"><a href="beast/more_examples/expect_100_continue_client.html">Expect
  116. 100-continue (Client) &#128161;</a></span></dt>
  117. <dt><span class="section"><a href="beast/more_examples/expect_100_continue_server.html">Expect
  118. 100-continue (Server) &#128161;</a></span></dt>
  119. <dt><span class="section"><a href="beast/more_examples/head_request_client.html">HEAD request
  120. (Client) &#128161;</a></span></dt>
  121. <dt><span class="section"><a href="beast/more_examples/head_response_server.html">HEAD response
  122. (Server) &#128161;</a></span></dt>
  123. <dt><span class="section"><a href="beast/more_examples/http_relay.html">HTTP Relay &#128161;</a></span></dt>
  124. <dt><span class="section"><a href="beast/more_examples/send_child_process_output.html">Send Child
  125. Process Output &#128161;</a></span></dt>
  126. </dl></dd>
  127. <dt><span class="section"><a href="beast/using_websocket.html">WebSocket</a></span></dt>
  128. <dd><dl>
  129. <dt><span class="section"><a href="beast/using_websocket/establishing_connections.html">Connecting</a></span></dt>
  130. <dt><span class="section"><a href="beast/using_websocket/handshaking.html">Handshaking</a></span></dt>
  131. <dt><span class="section"><a href="beast/using_websocket/decorator.html">Decorator</a></span></dt>
  132. <dt><span class="section"><a href="beast/using_websocket/messages.html">Messages</a></span></dt>
  133. <dt><span class="section"><a href="beast/using_websocket/control_frames.html">Control Frames</a></span></dt>
  134. <dt><span class="section"><a href="beast/using_websocket/timeouts.html">Timeouts</a></span></dt>
  135. <dt><span class="section"><a href="beast/using_websocket/teardown.html">Teardown</a></span></dt>
  136. <dt><span class="section"><a href="beast/using_websocket/notes.html">Notes</a></span></dt>
  137. </dl></dd>
  138. <dt><span class="section"><a href="beast/concepts.html">Concepts</a></span></dt>
  139. <dd><dl>
  140. <dt><span class="section"><a href="beast/concepts/Body.html">Body</a></span></dt>
  141. <dt><span class="section"><a href="beast/concepts/BodyReader.html">BodyReader</a></span></dt>
  142. <dt><span class="section"><a href="beast/concepts/BodyWriter.html">BodyWriter</a></span></dt>
  143. <dt><span class="section"><a href="beast/concepts/BufferSequence.html">BufferSequence</a></span></dt>
  144. <dt><span class="section"><a href="beast/concepts/DynamicBuffer.html">DynamicBuffer</a></span></dt>
  145. <dt><span class="section"><a href="beast/concepts/Fields.html">Fields</a></span></dt>
  146. <dt><span class="section"><a href="beast/concepts/FieldsWriter.html">FieldsWriter</a></span></dt>
  147. <dt><span class="section"><a href="beast/concepts/File.html">File</a></span></dt>
  148. <dt><span class="section"><a href="beast/concepts/RatePolicy.html">RatePolicy</a></span></dt>
  149. <dt><span class="section"><a href="beast/concepts/streams.html">Streams</a></span></dt>
  150. </dl></dd>
  151. <dt><span class="section"><a href="beast/design_choices.html">Design Choices</a></span></dt>
  152. <dd><dl>
  153. <dt><span class="section"><a href="beast/design_choices/http_message_container.html">HTTP Message
  154. Container &#127910;</a></span></dt>
  155. <dt><span class="section"><a href="beast/design_choices/http_comparison_to_other_librari.html">HTTP
  156. Comparison to Other Libraries</a></span></dt>
  157. <dt><span class="section"><a href="beast/design_choices/comparison_to_zaphoyd_studios_we.html">Comparison
  158. to Zaphoyd Studios WebSocket++</a></span></dt>
  159. <dt><span class="section"><a href="beast/design_choices/faq.html">FAQ</a></span></dt>
  160. </dl></dd>
  161. <dt><span class="section"><a href="beast/moved1.html">Release Notes (Moved)</a></span></dt>
  162. <dt><span class="section"><a href="beast/moved2.html">Reference (Moved)</a></span></dt>
  163. <dt><span class="section"><a href="beast/index.html">Index</a></span></dt>
  164. </dl>
  165. </div>
  166. <p>
  167. <span class="green">&#9733;</span> indicates a new or updated section in
  168. this version.
  169. </p>
  170. <p>
  171. &#128161; contains example source code.
  172. </p>
  173. <p>
  174. &#127910; contains video presentation content
  175. </p>
  176. </div>
  177. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  178. <td align="left"><p><small>Last revised: December 10, 2019 at 00:24:23 GMT</small></p></td>
  179. <td align="right"><div class="copyright-footer"></div></td>
  180. </tr></table>
  181. <hr>
  182. <div class="spirit-nav"><a accesskey="n" href="beast/quickref.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
  183. </body>
  184. </html>