1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" "../../../../tools/boostbook/dtd/boostbook.dtd">
5 Copyright (c) 2016-2019 Vinnie Falco (vinnie dot falco at gmail dot com)
7 Distributed under the Boost Software License, Version 1.0. (See accompanying
8 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
10 Official repository: https://github.com/boostorg/beast
13 <informaltable frame="all">
18 <colspec colname="a"/><colspec colname="b"/><colspec colname="c"/><colspec colname="d"/><colspec colname="e"/>
20 <entry valign="center" namest="a" nameend="e"><bridgehead renderas="sect2">Core</bridgehead></entry>
24 <bridgehead renderas="sect3">Classes <emphasis role="normal">(1 of 2)</emphasis></bridgehead>
25 <simplelist type="vert" columns="1">
26 <member><link linkend="beast.ref.boost__beast__async_base">async_base</link></member>
27 <member><link linkend="beast.ref.boost__beast__basic_stream">basic_stream</link></member>
28 <member><link linkend="beast.ref.boost__beast__file">file</link></member>
29 <member><link linkend="beast.ref.boost__beast__file_mode">file_mode</link></member>
30 <member><link linkend="beast.ref.boost__beast__file_posix">file_posix</link></member>
31 <member><link linkend="beast.ref.boost__beast__file_stdio">file_stdio</link></member>
32 <member><link linkend="beast.ref.boost__beast__file_win32">file_win32</link></member>
33 <member><link linkend="beast.ref.boost__beast__flat_stream">flat_stream</link></member>
34 <member><link linkend="beast.ref.boost__beast__iequal">iequal</link></member>
35 <member><link linkend="beast.ref.boost__beast__iless">iless</link></member>
36 <member><link linkend="beast.ref.boost__beast__rate_policy_access">rate_policy_access</link></member>
37 <member><link linkend="beast.ref.boost__beast__saved_handler">saved_handler</link></member>
38 <member><link linkend="beast.ref.boost__beast__simple_rate_policy">simple_rate_policy</link></member>
42 <bridgehead renderas="sect3">Classes <emphasis role="normal">(2 of 2)</emphasis></bridgehead>
43 <simplelist type="vert" columns="1">
44 <member><link linkend="beast.ref.boost__beast__span">span</link></member>
45 <member><link linkend="beast.ref.boost__beast__static_string">static_string</link></member>
46 <member><link linkend="beast.ref.boost__beast__stable_async_base">stable_async_base</link></member>
47 <member><link linkend="beast.ref.boost__beast__string_param">string_param</link></member>
48 <member><link linkend="beast.ref.boost__beast__string_view">string_view</link></member>
49 <member><link linkend="beast.ref.boost__beast__tcp_stream">tcp_stream</link></member>
50 <member><link linkend="beast.ref.boost__beast__unlimited_rate_policy">unlimited_rate_policy</link></member>
52 <bridgehead renderas="sect3">Constants</bridgehead>
53 <simplelist type="vert" columns="1">
54 <member><link linkend="beast.ref.boost__beast__condition">condition</link></member>
55 <member><link linkend="beast.ref.boost__beast__error">error</link></member>
56 <member><link linkend="beast.ref.boost__beast__file_mode">file_mode</link></member>
57 <member><link linkend="beast.ref.boost__beast__role_type">role_type</link></member>
61 <bridgehead renderas="sect3">Functions</bridgehead>
62 <simplelist type="vert" columns="1">
63 <member><link linkend="beast.ref.boost__beast__allocate_stable">allocate_stable</link></member>
64 <member><link linkend="beast.ref.boost__beast__async_detect_ssl">async_detect_ssl</link></member>
65 <member><link linkend="beast.ref.boost__beast__beast_close_socket">beast_close_socket</link></member>
66 <member><link linkend="beast.ref.boost__beast__bind_front_handler">bind_front_handler</link></member>
67 <member><link linkend="beast.ref.boost__beast__bind_handler">bind_handler</link></member>
68 <member><link linkend="beast.ref.boost__beast__close_socket">close_socket</link></member>
69 <member><link linkend="beast.ref.boost__beast__detect_ssl">detect_ssl</link></member>
70 <member><link linkend="beast.ref.boost__beast__generic_category">generic_category</link></member>
71 <member><link linkend="beast.ref.boost__beast__get_lowest_layer">get_lowest_layer</link></member>
72 <member><link linkend="beast.ref.boost__beast__iequals">iequals</link></member>
73 <member><link linkend="beast.ref.boost__beast__to_static_string">to_static_string</link></member>
77 <bridgehead renderas="sect3">Type Traits</bridgehead>
78 <simplelist type="vert" columns="1">
79 <member><link linkend="beast.ref.boost__beast__executor_type">executor_type</link></member>
80 <member><link linkend="beast.ref.boost__beast__lowest_layer_type">lowest_layer_type</link></member>
81 <member><link linkend="beast.ref.boost__beast__has_get_executor">has_get_executor</link></member>
82 <member><link linkend="beast.ref.boost__beast__is_async_read_stream">is_async_read_stream</link></member>
83 <member><link linkend="beast.ref.boost__beast__is_async_write_stream">is_async_write_stream</link></member>
84 <member><link linkend="beast.ref.boost__beast__is_async_stream">is_async_stream</link></member>
85 <member><link linkend="beast.ref.boost__beast__is_file">is_file</link></member>
86 <member><link linkend="beast.ref.boost__beast__is_sync_read_stream">is_sync_read_stream</link></member>
87 <member><link linkend="beast.ref.boost__beast__is_sync_stream">is_sync_stream</link></member>
88 <member><link linkend="beast.ref.boost__beast__is_sync_write_stream">is_sync_write_stream</link></member>
90 <bridgehead renderas="sect3">SSL</bridgehead>
91 <simplelist type="vert" columns="1">
92 <member><link linkend="beast.ref.boost__beast__ssl_stream">ssl_stream</link></member>
96 <bridgehead renderas="sect3">Aliases</bridgehead>
97 <simplelist type="vert" columns="1">
98 <member><link linkend="beast.ref.boost__beast__errc">errc</link></member>
99 <member><link linkend="beast.ref.boost__beast__error_category">error_category</link></member>
100 <member><link linkend="beast.ref.boost__beast__error_code">error_code</link></member>
101 <member><link linkend="beast.ref.boost__beast__error_condition">error_condition</link></member>
102 <member><link linkend="beast.ref.boost__beast__system_category">system_category</link></member>
103 <member><link linkend="beast.ref.boost__beast__system_error">system_error</link></member>
105 <bridgehead renderas="sect3">Concepts</bridgehead>
106 <simplelist type="vert" columns="1">
107 <member><link linkend="beast.concepts.streams.AsyncStream">AsyncStream</link></member>
108 <member><link linkend="beast.concepts.File">File</link></member>
109 <member><link linkend="beast.concepts.RatePolicy">RatePolicy</link></member>
110 <member><link linkend="beast.concepts.streams.Stream">Stream</link></member>
111 <member><link linkend="beast.concepts.streams.SyncStream">SyncStream</link></member>
117 Buffers and Buffer-Oriented Operations
120 <colspec colname="a"/><colspec colname="b"/><colspec colname="c"/><colspec colname="d"/>
122 <entry valign="center" namest="a" nameend="d"><bridgehead renderas="sect2">Buffers and Buffer-Oriented Operations</bridgehead></entry>
126 <bridgehead renderas="sect3">Classes</bridgehead>
127 <simplelist type="vert" columns="1">
128 <member><link linkend="beast.ref.boost__beast__basic_flat_buffer">basic_flat_buffer</link></member>
129 <member><link linkend="beast.ref.boost__beast__basic_multi_buffer">basic_multi_buffer</link></member>
130 <member><link linkend="beast.ref.boost__beast__buffered_read_stream">buffered_read_stream</link></member>
131 <member><link linkend="beast.ref.boost__beast__buffers_adaptor">buffers_adaptor</link></member>
132 <member><link linkend="beast.ref.boost__beast__buffers_cat_view">buffers_cat_view</link></member>
133 <member><link linkend="beast.ref.boost__beast__buffers_prefix_view">buffers_prefix_view</link></member>
134 <member><link linkend="beast.ref.boost__beast__buffers_suffix">buffers_suffix</link></member>
135 <member><link linkend="beast.ref.boost__beast__flat_buffer">flat_buffer</link></member>
136 <member><link linkend="beast.ref.boost__beast__flat_static_buffer">flat_static_buffer</link></member>
137 <member><link linkend="beast.ref.boost__beast__flat_static_buffer_base">flat_static_buffer_base</link></member>
138 <member><link linkend="beast.ref.boost__beast__multi_buffer">multi_buffer</link></member>
139 <member><link linkend="beast.ref.boost__beast__static_buffer">static_buffer</link></member>
140 <member><link linkend="beast.ref.boost__beast__static_buffer_base">static_buffer_base</link></member>
142 </entry><entry valign="top">
143 <bridgehead renderas="sect3">Functions</bridgehead>
144 <simplelist type="vert" columns="1">
145 <member><link linkend="beast.ref.boost__beast__buffer_bytes">buffer_bytes</link></member>
146 <member><link linkend="beast.ref.boost__beast__buffers_cat">buffers_cat</link></member>
147 <member><link linkend="beast.ref.boost__beast__buffers_front">buffers_front</link></member>
148 <member><link linkend="beast.ref.boost__beast__buffers_prefix">buffers_prefix</link></member>
149 <member><link linkend="beast.ref.boost__beast__buffers_range">buffers_range</link></member>
150 <member><link linkend="beast.ref.boost__beast__buffers_range_ref">buffers_range_ref</link></member>
151 <member><link linkend="beast.ref.boost__beast__buffers_to_string">buffers_to_string</link></member>
152 <member><link linkend="beast.ref.boost__beast__make_printable">make_printable</link></member>
153 <member><link linkend="beast.ref.boost__beast__ostream">ostream</link></member>
154 <member><link linkend="beast.ref.boost__beast__read_size">read_size</link></member>
155 <member><link linkend="beast.ref.boost__beast__read_size_or_throw">read_size_or_throw</link></member>
157 </entry><entry valign="top">
158 <bridgehead renderas="sect3">Type Traits</bridgehead>
159 <simplelist type="vert" columns="1">
160 <member><link linkend="beast.ref.boost__beast__buffers_type">buffers_type</link></member>
161 <member><link linkend="beast.ref.boost__beast__buffers_iterator_type">buffers_iterator_type</link></member>
162 <member><link linkend="beast.ref.boost__beast__is_const_buffer_sequence">is_const_buffer_sequence</link></member>
163 <member><link linkend="beast.ref.boost__beast__is_mutable_buffer_sequence">is_mutable_buffer_sequence</link></member>
165 </entry><entry valign="top">
166 <bridgehead renderas="sect3">Concepts</bridgehead>
167 <simplelist type="vert" columns="1">
168 <member><link linkend="beast.concepts.BufferSequence">BufferSequence</link></member>
169 <member><link linkend="beast.concepts.DynamicBuffer">DynamicBuffer</link></member>
178 <colspec colname="a"/><colspec colname="b"/><colspec colname="c"/><colspec colname="d"/>
180 <entry valign="center" namest="a" nameend="c"><bridgehead renderas="sect2">HTTP/1</bridgehead></entry>
181 <entry valign="center" namest="d" nameend="d"><bridgehead renderas="sect2">WebSocket</bridgehead></entry>
185 <bridgehead renderas="sect3">Classes <emphasis role="normal">(1 of 2)</emphasis></bridgehead>
186 <simplelist type="vert" columns="1">
187 <member><link linkend="beast.ref.boost__beast__http__basic_chunk_extensions">basic_chunk_extensions</link></member>
188 <member><link linkend="beast.ref.boost__beast__http__basic_dynamic_body">basic_dynamic_body</link></member>
189 <member><link linkend="beast.ref.boost__beast__http__basic_fields">basic_fields</link></member>
190 <member><link linkend="beast.ref.boost__beast__http__basic_file_body">basic_file_body</link></member>
191 <member><link linkend="beast.ref.boost__beast__http__basic_parser">basic_parser</link></member>
192 <member><link linkend="beast.ref.boost__beast__http__basic_string_body">basic_string_body</link></member>
193 <member><link linkend="beast.ref.boost__beast__http__buffer_body">buffer_body</link></member>
194 <member><link linkend="beast.ref.boost__beast__http__chunk_body">chunk_body</link></member>
195 <member><link linkend="beast.ref.boost__beast__http__chunk_crlf">chunk_crlf</link></member>
196 <member><link linkend="beast.ref.boost__beast__http__chunk_extensions">chunk_extensions</link></member>
197 <member><link linkend="beast.ref.boost__beast__http__chunk_header">chunk_header</link></member>
198 <member><link linkend="beast.ref.boost__beast__http__chunk_last">chunk_last</link></member>
199 <member><link linkend="beast.ref.boost__beast__http__dynamic_body">dynamic_body</link></member>
200 <member><link linkend="beast.ref.boost__beast__http__empty_body">empty_body</link></member>
201 <member><link linkend="beast.ref.boost__beast__http__fields">fields</link></member>
202 <member><link linkend="beast.ref.boost__beast__http__file_body">file_body</link></member>
203 <member><link linkend="beast.ref.boost__beast__http__header">header</link></member>
204 <member><link linkend="beast.ref.boost__beast__http__message">message</link></member>
205 <member><link linkend="beast.ref.boost__beast__http__parser">parser</link></member>
206 <member><link linkend="beast.ref.boost__beast__http__request">request</link></member>
207 <member><link linkend="beast.ref.boost__beast__http__request_header">request_header</link></member>
208 <member><link linkend="beast.ref.boost__beast__http__request_parser">request_parser</link></member>
209 <member><link linkend="beast.ref.boost__beast__http__request_serializer">request_serializer</link></member>
210 <member><link linkend="beast.ref.boost__beast__http__response">response</link></member>
211 <member><link linkend="beast.ref.boost__beast__http__response_header">response_header</link></member>
212 <member><link linkend="beast.ref.boost__beast__http__response_parser">response_parser</link></member>
213 <member><link linkend="beast.ref.boost__beast__http__response_serializer">response_serializer</link></member>
214 <member><link linkend="beast.ref.boost__beast__http__serializer">serializer</link></member>
218 <bridgehead renderas="sect3">Classes <emphasis role="normal">(2 of 2)</emphasis></bridgehead>
219 <simplelist type="vert" columns="1">
220 <member><link linkend="beast.ref.boost__beast__http__span_body">span_body</link></member>
221 <member><link linkend="beast.ref.boost__beast__http__string_body">string_body</link></member>
222 <member><link linkend="beast.ref.boost__beast__http__vector_body">vector_body</link></member>
224 <bridgehead renderas="sect3">Functions</bridgehead>
225 <simplelist type="vert" columns="1">
226 <member><link linkend="beast.ref.boost__beast__http__async_read">async_read</link></member>
227 <member><link linkend="beast.ref.boost__beast__http__async_read_header">async_read_header</link></member>
228 <member><link linkend="beast.ref.boost__beast__http__async_read_some">async_read_some</link></member>
229 <member><link linkend="beast.ref.boost__beast__http__async_write">async_write</link></member>
230 <member><link linkend="beast.ref.boost__beast__http__async_write_header">async_write_header</link></member>
231 <member><link linkend="beast.ref.boost__beast__http__async_write_some">async_write_some</link></member>
232 <member><link linkend="beast.ref.boost__beast__http__int_to_status">int_to_status</link></member>
233 <member><link linkend="beast.ref.boost__beast__http__make_chunk">make_chunk</link></member>
234 <member><link linkend="beast.ref.boost__beast__http__make_chunk_last">make_chunk_last</link></member>
235 <member><link linkend="beast.ref.boost__beast__http__obsolete_reason">obsolete_reason</link></member>
236 <member><link linkend="beast.ref.boost__beast__http__operator_lt__lt_">operator<<</link></member>
237 <member><link linkend="beast.ref.boost__beast__http__read">read</link></member>
238 <member><link linkend="beast.ref.boost__beast__http__read_header">read_header</link></member>
239 <member><link linkend="beast.ref.boost__beast__http__read_some">read_some</link></member>
240 <member><link linkend="beast.ref.boost__beast__http__string_to_field">string_to_field</link></member>
241 <member><link linkend="beast.ref.boost__beast__http__string_to_verb">string_to_verb</link></member>
242 <member><link linkend="beast.ref.boost__beast__http__swap">swap</link></member>
243 <member><link linkend="beast.ref.boost__beast__http__to_string">to_string</link></member>
244 <member><link linkend="beast.ref.boost__beast__http__to_status_class">to_status_class</link></member>
245 <member><link linkend="beast.ref.boost__beast__http__write">write</link></member>
246 <member><link linkend="beast.ref.boost__beast__http__write_header">write_header</link></member>
247 <member><link linkend="beast.ref.boost__beast__http__write_some">write_some</link></member>
251 <bridgehead renderas="sect3">Constants</bridgehead>
252 <simplelist type="vert" columns="1">
253 <member><link linkend="beast.ref.boost__beast__http__error">error</link></member>
254 <member><link linkend="beast.ref.boost__beast__http__field">field</link></member>
255 <member><link linkend="beast.ref.boost__beast__http__status">status</link></member>
256 <member><link linkend="beast.ref.boost__beast__http__status_class">status_class</link></member>
257 <member><link linkend="beast.ref.boost__beast__http__verb">verb</link></member>
259 <bridgehead renderas="sect3">Type Traits</bridgehead>
260 <simplelist type="vert" columns="1">
261 <member><link linkend="beast.ref.boost__beast__http__is_body">is_body</link></member>
262 <member><link linkend="beast.ref.boost__beast__http__is_body_reader">is_body_reader</link></member>
263 <member><link linkend="beast.ref.boost__beast__http__is_body_writer">is_body_writer</link></member>
264 <member><link linkend="beast.ref.boost__beast__http__is_fields">is_fields</link></member>
265 <member><link linkend="beast.ref.boost__beast__http__is_mutable_body_writer">is_mutable_body_writer</link></member>
267 <bridgehead renderas="sect3">Concepts</bridgehead>
268 <simplelist type="vert" columns="1">
269 <member><link linkend="beast.concepts.Body">Body</link></member>
270 <member><link linkend="beast.concepts.BodyReader">BodyReader</link></member>
271 <member><link linkend="beast.concepts.BodyWriter">BodyWriter</link></member>
272 <member><link linkend="beast.concepts.Fields">Fields</link></member>
273 <member><link linkend="beast.concepts.FieldsWriter">FieldsWriter</link></member>
275 <bridgehead renderas="sect3">RFC7230</bridgehead>
276 <simplelist type="vert" columns="1">
277 <member><link linkend="beast.ref.boost__beast__http__ext_list">ext_list</link></member>
278 <member><link linkend="beast.ref.boost__beast__http__opt_token_list">opt_token_list</link></member>
279 <member><link linkend="beast.ref.boost__beast__http__param_list">param_list</link></member>
280 <member><link linkend="beast.ref.boost__beast__http__token_list">token_list</link></member>
284 <bridgehead renderas="sect3">Classes</bridgehead>
285 <simplelist type="vert" columns="1">
286 <member><link linkend="beast.ref.boost__beast__websocket__close_reason">close_reason</link></member>
287 <member><link linkend="beast.ref.boost__beast__websocket__ping_data">ping_data</link></member>
288 <member><link linkend="beast.ref.boost__beast__websocket__stream">stream</link></member>
289 <member><link linkend="beast.ref.boost__beast__websocket__stream_base">stream_base</link></member>
290 <member><link linkend="beast.ref.boost__beast__websocket__reason_string">reason_string</link></member>
292 <bridgehead renderas="sect3">Functions</bridgehead>
293 <simplelist type="vert" columns="1">
294 <member><link linkend="beast.ref.boost__beast__websocket__async_teardown">async_teardown</link></member>
295 <member><link linkend="beast.ref.boost__beast__websocket__is_upgrade">is_upgrade</link></member>
296 <member><link linkend="beast.ref.boost__beast__websocket__seed_prng">seed_prng</link></member>
297 <member><link linkend="beast.ref.boost__beast__websocket__teardown">teardown</link></member>
299 <bridgehead renderas="sect3">Options</bridgehead>
300 <simplelist type="vert" columns="1">
301 <member><link linkend="beast.ref.boost__beast__websocket__permessage_deflate">permessage_deflate</link></member>
302 <member><link linkend="beast.ref.boost__beast__websocket__stream_base__decorator">decorator</link></member>
303 <member><link linkend="beast.ref.boost__beast__websocket__stream_base__timeout">timeout</link></member>
305 <bridgehead renderas="sect3">Constants</bridgehead>
306 <simplelist type="vert" columns="1">
307 <member><link linkend="beast.ref.boost__beast__websocket__close_code">close_code</link></member>
308 <member><link linkend="beast.ref.boost__beast__websocket__condition">condition</link></member>
309 <member><link linkend="beast.ref.boost__beast__websocket__error">error</link></member>
310 <member><link linkend="beast.ref.boost__beast__websocket__frame_type">frame_type</link></member>
319 <colspec colname="a"/><colspec colname="b"/><colspec colname="c"/>
321 <entry valign="center" namest="a" nameend="c"><bridgehead renderas="sect2">ZLib</bridgehead></entry>
325 <bridgehead renderas="sect3">Classes</bridgehead>
326 <simplelist type="vert" columns="1">
327 <member><link linkend="beast.ref.boost__beast__zlib__deflate_stream">deflate_stream</link></member>
328 <member><link linkend="beast.ref.boost__beast__zlib__inflate_stream">inflate_stream</link></member>
329 <member><link linkend="beast.ref.boost__beast__zlib__z_params">z_params</link></member>
331 </entry><entry valign="top">
332 <bridgehead renderas="sect3">Functions</bridgehead>
333 <simplelist type="vert" columns="1">
334 <member><link linkend="beast.ref.boost__beast__zlib__deflate_upper_bound">deflate_upper_bound</link></member>
336 </entry><entry valign="top">
337 <bridgehead renderas="sect3">Constants</bridgehead>
338 <simplelist type="vert" columns="1">
339 <member><link linkend="beast.ref.boost__beast__zlib__error">error</link></member>
340 <member><link linkend="beast.ref.boost__beast__zlib__Flush">Flush</link></member>
341 <member><link linkend="beast.ref.boost__beast__zlib__Strategy">Strategy</link></member>
350 <colspec colname="a"/>
351 <colspec colname="b"/>
352 <colspec colname="c"/>
355 <entry valign="center" namest="a" nameend="c">
356 <bridgehead renderas="sect2">Experimental</bridgehead>
363 <bridgehead renderas="sect3">Classes</bridgehead>
364 <simplelist type="vert" columns="1">
365 <member><link linkend="beast.ref.boost__beast__http__icy_stream">http::icy_stream</link></member>
366 <member><link linkend="beast.ref.boost__beast__test__fail_count">test::fail_count</link></member>
367 <member><link linkend="beast.ref.boost__beast__test__handler">test::handler</link></member>
368 <member><link linkend="beast.ref.boost__beast__test__stream">test::stream</link></member>
372 <bridgehead renderas="sect3">Functions</bridgehead>
373 <simplelist type="vert" columns="1">
374 <member><link linkend="beast.ref.boost__beast__test__connect">test::connect</link></member>
375 <member><link linkend="beast.ref.boost__beast__test__any_handler">test::any_handler</link></member>
376 <member><link linkend="beast.ref.boost__beast__test__fail_handler">test::fail_handler</link></member>
377 <member><link linkend="beast.ref.boost__beast__test__success_handler">test::success_handler</link></member>
381 <bridgehead renderas="sect3">Constants</bridgehead>
382 <simplelist type="vert" columns="1">
383 <member><link linkend="beast.ref.boost__beast__test__error">test::error</link></member>
394 <colspec colname="a"/>
397 <entry valign="center" namest="a" nameend="a">
398 <bridgehead renderas="sect2">Diagnostic (Debug)</bridgehead>
405 <simplelist type="vert" columns="1">
406 <member><link linkend="beast.ref.boost__beast__doc_debug">doc_debug</link></member>
407 <member><link linkend="beast.ref.boost__beast__nested__nested_doc_debug">nested_doc_debug</link></member>