forked from boostorg/beast
75b0571e83
fix #373 * concepts.hpp is renamed to type_traits.hpp * Body reader and writer concepts are renamed
126 lines
5.1 KiB
Plaintext
126 lines
5.1 KiB
Plaintext
[/
|
|
Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
|
|
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
]
|
|
|
|
[library Beast
|
|
[quickbook 1.6]
|
|
[copyright 2013 - 2017 Vinnie Falco]
|
|
[purpose Networking Protocol Library]
|
|
[license
|
|
Distributed under the Boost Software License, Version 1.0.
|
|
(See accompanying file LICENSE_1_0.txt or copy at
|
|
[@http://www.boost.org/LICENSE_1_0.txt])
|
|
]
|
|
[authors [Falco, Vinnie]]
|
|
[category template]
|
|
[category generic]
|
|
]
|
|
|
|
[template mdash[] '''— ''']
|
|
[template indexterm1[term1] '''<indexterm><primary>'''[term1]'''</primary></indexterm>''']
|
|
[template indexterm2[term1 term2] '''<indexterm><primary>'''[term1]'''</primary><secondary>'''[term2]'''</secondary></indexterm>''']
|
|
|
|
[def __N3747__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3747.pdf [*N3747]]]
|
|
[def __N4588__ [@http://cplusplus.github.io/networking-ts/draft.pdf [*N4588]]]
|
|
[def __rfc6455__ [@https://tools.ietf.org/html/rfc6455 rfc6455]]
|
|
[def __rfc7230__ [@https://tools.ietf.org/html/rfc7230 rfc7230]]
|
|
|
|
[def __asio_handler_invoke__ [@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_invoke.html `asio_handler_invoke`]]
|
|
[def __asio_handler_allocate__ [@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_allocate.html `asio_handler_allocate`]]
|
|
[def __void_or_deduced__ [@http://www.boost.org/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function ['void-or-deduced]]]
|
|
[def __use_future__ [@http://www.boost.org/doc/html/boost_asio/reference/use_future_t.html `boost::asio::use_future`]]
|
|
[def __yield_context__ [@http://www.boost.org/doc/html/boost_asio/reference/yield_context.html `boost::asio::yield_context`]]
|
|
|
|
[def __AsyncReadStream__ [@http://www.boost.org/doc/html/boost_asio/reference/AsyncReadStream.html [*AsyncReadStream]]]
|
|
[def __AsyncWriteStream__ [@http://www.boost.org/doc/html/boost_asio/reference/AsyncWriteStream.html [*AsyncWriteStream]]]
|
|
[def __CompletionHandler__ [@http://www.boost.org/doc/html/boost_asio/reference/CompletionHandler.html [*CompletionHandler]]]
|
|
[def __ConstBufferSequence__ [@http://www.boost.org/doc/html/boost_asio/reference/ConstBufferSequence.html [*ConstBufferSequence]]]
|
|
[def __Handler__ [@http://www.boost.org/doc/html/boost_asio/reference/Handler.html [*Handler]]]
|
|
[def __MutableBufferSequence__ [@http://www.boost.org/doc/html/boost_asio/reference/MutableBufferSequence.html [*MutableBufferSequence]]]
|
|
[def __SyncReadStream__ [@http://www.boost.org/doc/html/boost_asio/reference/SyncReadStream.html [*SyncReadStream]]]
|
|
[def __SyncWriteStream__ [@http://www.boost.org/doc/html/boost_asio/reference/SyncWriteStream.html [*SyncWriteStream]]]
|
|
|
|
[def __Body__ [link beast.ref.Body [*Body]]]
|
|
[def __DynamicBuffer__ [link beast.ref.DynamicBuffer [*DynamicBuffer]]]
|
|
[def __FieldSequence__ [link beast.ref.FieldSequence [*FieldSequence]]]
|
|
|
|
[def __basic_fields__ [link beast.ref.http__basic_fields `basic_fields`]]
|
|
[def __fields__ [link beast.ref.http__fields `fields`]]
|
|
[def __flat_buffer__ [link beast.ref.flat_buffer `flat_buffer`]]
|
|
[def __header__ [link beast.ref.http__header `header`]]
|
|
[def __message__ [link beast.ref.http__message `message`]]
|
|
[def __multi_buffer__ [link beast.ref.multi_buffer `multi_buffer`]]
|
|
[def __basic_multi_buffer__ [link beast.ref.basic_multi_buffer `basic_multi_buffer`]]
|
|
|
|
Beast is a cross-platform, header-only C++ library built on Boost.Asio that
|
|
provides implementations of the HTTP and WebSocket protocols.
|
|
|
|
[variablelist
|
|
[[
|
|
[link beast.overview Overview]
|
|
][
|
|
An introduction with features, requirements, and credits.
|
|
]]
|
|
[[
|
|
[link beast.core Core Concepts]
|
|
][
|
|
Library-wide concepts, classes, functions, and traits.
|
|
]]
|
|
[[
|
|
[link beast.http Using HTTP]
|
|
][
|
|
How to use Beast's HTTP interfaces in your applications.
|
|
]]
|
|
[[
|
|
[link beast.websocket Using WebSocket]
|
|
][
|
|
How to use Beast's WebSocket interfaces in your applications.
|
|
]]
|
|
[[
|
|
[link beast.example Examples]
|
|
][
|
|
Examples that illustrate the use of Beast in more complex applications.
|
|
]]
|
|
[[
|
|
[link beast.design Design]
|
|
][
|
|
Design rationale, answers to questions, library comparisons,
|
|
and special considerations for Boost Formal Review participants.
|
|
]]
|
|
[[
|
|
[link beast.ref Reference]
|
|
][
|
|
Detailed class and function reference.
|
|
]]
|
|
[[
|
|
[link beast.index Index]
|
|
][
|
|
Book-style text index of Beast documentation.
|
|
]]
|
|
]
|
|
|
|
[include overview.qbk]
|
|
[include core.qbk]
|
|
[include http.qbk]
|
|
[include websocket.qbk]
|
|
[include examples.qbk]
|
|
[include design.qbk]
|
|
|
|
[section:ref Reference]
|
|
[xinclude quickref.xml]
|
|
[include concept/Body.qbk]
|
|
[include concept/BodyReader.qbk]
|
|
[include concept/BodyWriter.qbk]
|
|
[include concept/BufferSequence.qbk]
|
|
[include concept/DynamicBuffer.qbk]
|
|
[include concept/Field.qbk]
|
|
[include concept/FieldSequence.qbk]
|
|
[include concept/Streams.qbk]
|
|
[include reference.qbk]
|
|
[endsect]
|
|
|
|
[xinclude index.xml]
|