2 Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
4 Distributed under the Boost Software License, Version 1.0. (See accompanying
5 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
10 [copyright 2013 - 2017 Vinnie Falco]
11 [purpose Networking Protocol Library]
13 Distributed under the Boost Software License, Version 1.0.
14 (See accompanying file LICENSE_1_0.txt or copy at
15 [@http://www.boost.org/LICENSE_1_0.txt])
17 [authors [Falco, Vinnie]]
22 [template mdash[] '''— ''']
23 [template indexterm1[term1] '''<indexterm><primary>'''[term1]'''</primary></indexterm>''']
24 [template indexterm2[term1 term2] '''<indexterm><primary>'''[term1]'''</primary><secondary>'''[term2]'''</secondary></indexterm>''']
26 [def __N4588__ [@http://cplusplus.github.io/networking-ts/draft.pdf [*N4588]]]
27 [def __rfc6455__ [@https://tools.ietf.org/html/rfc6455 rfc6455]]
28 [def __rfc7230__ [@https://tools.ietf.org/html/rfc7230 rfc7230]]
30 [def __asio_handler_invoke__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/asio_handler_invoke.html `asio_handler_invoke`]]
31 [def __asio_handler_allocate__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/asio_handler_allocate.html `asio_handler_allocate`]]
32 [def __void_or_deduced__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function ['void-or-deduced]]]
34 [def __AsyncReadStream__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/AsyncReadStream.html [*AsyncReadStream]]]
35 [def __AsyncWriteStream__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/AsyncWriteStream.html [*AsyncWriteStream]]]
36 [def __CompletionHandler__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/CompletionHandler.html [*CompletionHandler]]]
37 [def __ConstBufferSequence__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/ConstBufferSequence.html [*ConstBufferSequence]]]
38 [def __Handler__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/Handler.html [*Handler]]]
39 [def __MutableBufferSequence__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/MutableBufferSequence.html [*MutableBufferSequence]]]
40 [def __SyncReadStream__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/SyncReadStream.html [*SyncReadStream]]]
41 [def __SyncWriteStream__ [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/SyncWriteStream.html [*SyncWriteStream]]]
43 [def __Body__ [link beast.ref.Body [*`Body`]]]
44 [def __DynamicBuffer__ [link beast.ref.DynamicBuffer [*DynamicBuffer]]]
45 [def __FieldSequence__ [link beast.ref.FieldSequence [*FieldSequence]]]
46 [def __Parser__ [link beast.ref.Parser [*`Parser`]]]
48 [def __basic_fields__ [link beast.ref.http__basic_fields `basic_fields`]]
49 [def __fields__ [link beast.ref.http__fields `fields`]]
50 [def __header__ [link beast.ref.http__header `header`]]
51 [def __message__ [link beast.ref.http__message `message`]]
52 [def __streambuf__ [link beast.ref.streambuf `streambuf`]]
53 [def __basic_streambuf__ [link beast.ref.basic_streambuf `basic_streambuf`]]
55 Beast is a cross-platform, header-only C++ library built on Boost.Asio that
56 provides implementations of the HTTP and WebSocket protocols.
60 [link beast.overview Overview]
62 An introduction with features, requirements, and credits.
65 [link beast.http Using HTTP]
67 How to use Beast's HTTP interfaces in your applications.
70 [link beast.websocket Using WebSocket]
72 How to use Beast's WebSocket interfaces in your applications.
75 [link beast.example Examples]
77 Examples that illustrate the use of Beast in more complex applications.
80 [link beast.design Design]
82 Design rationale, answers to review questions, and
83 other library comparisons.
86 [link beast.ref Reference]
88 Detailed class and function reference.
91 [link beast.index Index]
93 Book-style text index of Beast documentation.
97 [include overview.qbk]
99 [include websocket.qbk]
100 [include examples.qbk]
103 [section:ref Reference]
104 [xinclude quickref.xml]
105 [include types/Body.qbk]
106 [include types/BufferSequence.qbk]
107 [include types/DynamicBuffer.qbk]
108 [include types/Field.qbk]
109 [include types/FieldSequence.qbk]
110 [include types/Reader.qbk]
111 [include types/Streams.qbk]
112 [include types/Writer.qbk]
113 [include reference.qbk]