boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-07-30 12:57:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update doc links

Browse Source
This commit is contained in:
Vinnie Falco
2017-10-25 17:08:26 -07:00
parent 80af45ecfb
commit 93c849d6d4
6 changed files with 42 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -1,3 +1,9 @@
Version 128:
* Update doc links
--------------------------------------------------------------------------------
Version 127: Version 127:
* Add BOOST_BEAST_NO_POSIX_FADVISE * Add BOOST_BEAST_NO_POSIX_FADVISE

44
doc/qbk/00_main.qbk
View File

@ -34,30 +34,30 @@
[def __rfc6455__ [@https://tools.ietf.org/html/rfc6455 rfc6455]] [def __rfc6455__ [@https://tools.ietf.org/html/rfc6455 rfc6455]]
[def __rfc7230__ [@https://tools.ietf.org/html/rfc7230 rfc7230]] [def __rfc7230__ [@https://tools.ietf.org/html/rfc7230 rfc7230]]
[def __Asio__ [@http://www.boost.org/doc/html/boost_asio.html Boost.Asio]] [def __Asio__ [@boost:/doc/html/boost_asio.html Boost.Asio]]
[def __async_initfn__ [@boost:/doc/html/boost_asio/reference/asynchronous_operations.html initiating function]]
[def __asio_handler_invoke__ [@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_invoke.html `asio_handler_invoke`]] [def __asio_handler_invoke__ [@boost:/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 __asio_handler_allocate__ [@boost:/doc/html/boost_asio/reference/asio_handler_allocate.html `asio_handler_allocate`]]
[def __io_context__ [@http://www.boost.org/doc/html/boost_asio/reference/io_context.html `io_context`]] [def __io_context__ [@boost:/doc/html/boost_asio/reference/io_context.html `boost::asio::io_context`]]
[def __socket__ [@http://www.boost.org/doc/html/boost_asio/reference/ip__tcp/socket.html `boost::asio::ip::tcp::socket`]] [def __executor_work_guard__ [@boost:/doc/html/boost_asio/reference/executor_work_guard.html `boost::asio::executor_work_guard`]]
[def __ssl_stream__ [@http://www.boost.org/doc/html/boost_asio/reference/ssl__stream.html `boost::asio::ssl::stream`]] [def __socket__ [@boost:/doc/html/boost_asio/reference/ip__tcp/socket.html `boost::asio::ip::tcp::socket`]]
[def __streambuf__ [@http://www.boost.org/doc/html/boost_asio/reference/streambuf.html `boost::asio::streambuf`]] [def __ssl_stream__ [@boost:/doc/html/boost_asio/reference/ssl__stream.html `boost::asio::ssl::stream`]]
[def __use_future__ [@http://www.boost.org/doc/html/boost_asio/reference/use_future_t.html `boost::asio::use_future`]] [def __streambuf__ [@boost:/doc/html/boost_asio/reference/streambuf.html `boost::asio::streambuf`]]
[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__ [@boost:/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 __void_or_deduced__ [@boost:/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function ['void-or-deduced]]]
[def __yield_context__ [@boost:/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 __AsyncReadStream__ [@boost:/doc/html/boost_asio/reference/AsyncReadStream.html [*AsyncReadStream]]]
[def __AsyncWriteStream__ [@http://www.boost.org/doc/html/boost_asio/reference/AsyncWriteStream.html [*AsyncWriteStream]]] [def __AsyncWriteStream__ [@boost:/doc/html/boost_asio/reference/AsyncWriteStream.html [*AsyncWriteStream]]]
[def __CompletionHandler__ [@http://www.boost.org/doc/html/boost_asio/reference/CompletionHandler.html [*CompletionHandler]]] [def __CompletionHandler__ [@boost:/doc/html/boost_asio/reference/CompletionHandler.html [*CompletionHandler]]]
[def __ConstBufferSequence__ [@http://www.boost.org/doc/html/boost_asio/reference/ConstBufferSequence.html [*ConstBufferSequence]]] [def __ConstBufferSequence__ [@boost:/doc/html/boost_asio/reference/ConstBufferSequence.html [*ConstBufferSequence]]]
[def __Handler__ [@http://www.boost.org/doc/html/boost_asio/reference/Handler.html [*Handler]]] [def __Handler__ [@boost:/doc/html/boost_asio/reference/Handler.html [*Handler]]]
[def __MutableBufferSequence__ [@http://www.boost.org/doc/html/boost_asio/reference/MutableBufferSequence.html [*MutableBufferSequence]]] [def __MutableBufferSequence__ [@boost:/doc/html/boost_asio/reference/MutableBufferSequence.html [*MutableBufferSequence]]]
[def __ReadHandler__ [@http://www.boost.org/doc/html/boost_asio/reference/ReadHandler.html [*ReadHandler]]] [def __ReadHandler__ [@boost:/doc/html/boost_asio/reference/ReadHandler.html [*ReadHandler]]]
[def __SyncReadStream__ [@http://www.boost.org/doc/html/boost_asio/reference/SyncReadStream.html [*SyncReadStream]]] [def __SyncReadStream__ [@boost:/doc/html/boost_asio/reference/SyncReadStream.html [*SyncReadStream]]]
[def __SyncWriteStream__ [@http://www.boost.org/doc/html/boost_asio/reference/SyncWriteStream.html [*SyncWriteStream]]] [def __SyncWriteStream__ [@boost:/doc/html/boost_asio/reference/SyncWriteStream.html [*SyncWriteStream]]]
[def __WriteHandler__ [@http://www.boost.org/doc/html/boost_asio/reference/WriteHandler.html [*WriteHandler]]] [def __WriteHandler__ [@boost:/doc/html/boost_asio/reference/WriteHandler.html [*WriteHandler]]]
[def __async_initfn__ [@http://www.boost.org/doc/html/boost_asio/reference/asynchronous_operations.html initiating function]]
[def __AsyncStream__ [link beast.concepts.streams.AsyncStream [*AsyncStream]]] [def __AsyncStream__ [link beast.concepts.streams.AsyncStream [*AsyncStream]]]
[def __Body__ [link beast.concepts.Body [*Body]]] [def __Body__ [link beast.concepts.Body [*Body]]]

17
doc/qbk/03_core/1_asio.qbk
View File

@ -30,26 +30,23 @@ special meaning:
[table Global Variables [table Global Variables
[[Name][Description]] [[Name][Description]]
[[ [[
[@http://www.boost.org/doc/html/boost_asio/reference/io_context.html [*`ioc`]] [@boost:/doc/html/boost_asio/reference/io_context.html [*`ioc`]]
][ ][
A variable of type A variable of type __io_context__ which is running on one separate thread,
[@http://www.boost.org/doc/html/boost_asio/reference/io_context.html `boost::asio::io_context`] and upon which an __executor_work_guard__ object has been constructed.
which is running on one separate thread, and upon which an
[@http://www.boost.org/doc/html/boost_asio/reference/executor_work.html `boost::asio::executor_work`]
object has been constructed.
]] ]]
[[ [[
[@http://www.boost.org/doc/html/boost_asio/reference/ip__tcp/socket.html [*`sock`]] [@boost:/doc/html/boost_asio/reference/ip__tcp/socket.html [*`sock`]]
][ ][
A variable of type A variable of type
[@http://www.boost.org/doc/html/boost_asio/reference/ip__tcp/socket.html `boost::asio::ip::tcp::socket`] [@boost:/doc/html/boost_asio/reference/ip__tcp/socket.html `boost::asio::ip::tcp::socket`]
which has already been connected to a remote host. which has already been connected to a remote host.
]] ]]
[[ [[
[@http://www.boost.org/doc/html/boost_asio/reference/ssl__stream.html [*`ssl_sock`]] [@boost:/doc/html/boost_asio/reference/ssl__stream.html [*`ssl_sock`]]
][ ][
A variable of type A variable of type
[@http://www.boost.org/doc/html/boost_asio/reference/ssl__stream.html `boost::asio::ssl::stream<boost::asio::ip::tcp::socket>`] [@boost:/doc/html/boost_asio/reference/ssl__stream.html `boost::asio::ssl::stream<boost::asio::ip::tcp::socket>`]
which is already connected and has handshaked with a remote host. which is already connected and has handshaked with a remote host.
]] ]]
[[ [[

10
doc/qbk/03_core/5_composed.qbk
View File

@ -120,28 +120,28 @@ declaration and definition of the "handler hooks". There are four hooks:
[table Handler Hooks [table Handler Hooks
[[Name][Description]] [[Name][Description]]
[[ [[
[@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_invoke.html `asio_handler_invoke`] [@boost:/doc/html/boost_asio/reference/asio_handler_invoke.html `asio_handler_invoke`]
][ ][
Default invoke function for handlers. This hooking function ensures Default invoke function for handlers. This hooking function ensures
that the invoked method used for the final handler is accessible at that the invoked method used for the final handler is accessible at
each intermediate step. each intermediate step.
]] ]]
[[ [[
[@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_allocate.html `asio_handler_allocate`] [@boost:/doc/html/boost_asio/reference/asio_handler_allocate.html `asio_handler_allocate`]
][ ][
Default allocation function for handlers. Implement `asio_handler_allocate` Default allocation function for handlers. Implement `asio_handler_allocate`
and `asio_handler_deallocate` for your own handlers to provide custom and `asio_handler_deallocate` for your own handlers to provide custom
allocation for temporary objects. allocation for temporary objects.
]] ]]
[[ [[
[@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_deallocate.html `asio_handler_deallocate`] [@boost:/doc/html/boost_asio/reference/asio_handler_deallocate.html `asio_handler_deallocate`]
][ ][
Default deallocation function for handlers. Implement `asio_handler_allocate` Default deallocation function for handlers. Implement `asio_handler_allocate`
and `asio_handler_deallocate` for your own handlers to provide custom and `asio_handler_deallocate` for your own handlers to provide custom
allocation for temporary objects. allocation for temporary objects.
]] ]]
[[ [[
[@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_is_continuation.html `asio_handler_is_continuation`] [@boost:/doc/html/boost_asio/reference/asio_handler_is_continuation.html `asio_handler_is_continuation`]
][ ][
Default continuation function for handlers. Implement Default continuation function for handlers. Implement
`asio_handler_is_continuation` for your own handlers to indicate when `asio_handler_is_continuation` for your own handlers to indicate when
@ -185,7 +185,7 @@ composed operations:
* For operations which complete immediately (i.e. without calling an * For operations which complete immediately (i.e. without calling an
intermediate initiating function), forgetting to use intermediate initiating function), forgetting to use
[@http://www.boost.org/doc/html/boost_asio/reference/post.html `boost::asio::post`] [@boost:/doc/html/boost_asio/reference/post.html `boost::asio::post`]
to invoke the final handler. This breaks the following initiating to invoke the final handler. This breaks the following initiating
function guarantee: ['Regardless of whether the asynchronous operation function guarantee: ['Regardless of whether the asynchronous operation
completes immediately or not, the handler will not be invoked from completes immediately or not, the handler will not be invoked from

2
doc/qbk/04_http/09_custom_body.qbk
View File

@ -73,7 +73,7 @@ something that is not a container for body octets, such as a
[@http://www.boost.org/libs/filesystem/doc/reference.html#class-path `boost::filesystem::path`]. [@http://www.boost.org/libs/filesystem/doc/reference.html#class-path `boost::filesystem::path`].
Or, a more structured container may be chosen. This declares a body's Or, a more structured container may be chosen. This declares a body's
value type as a JSON tree structure produced from a value type as a JSON tree structure produced from a
[@http://www.boost.org/doc/html/property_tree/parsers.html#property_tree.parsers.json_parser `json_parser`]: [@boost:/doc/html/property_tree/parsers.html#property_tree.parsers.json_parser `json_parser`]:
``` ```
#include <boost/property_tree/ptree.hpp> #include <boost/property_tree/ptree.hpp>
#include <boost/property_tree/json_parser.hpp> #include <boost/property_tree/json_parser.hpp>

4
doc/qbk/08_design/3_websocket_zaphoyd.qbk
View File

@ -281,9 +281,7 @@ notified when messages or frames have completed sending.
Beast doesn't allocate or make copies of buffers when sending data. The Beast doesn't allocate or make copies of buffers when sending data. The
caller's buffers are sent in-place. You can use any object meeting the caller's buffers are sent in-place. You can use any object meeting the
requirements of requirements of __ConstBufferSequence, permitting efficient scatter-gather I/O.
[@http://www.boost.org/doc/html/boost_asio/reference/ConstBufferSequence.html ConstBufferSequence],
permitting efficient scatter-gather I/O.
The [*ConstBufferSequence] interface allows callers to send data from The [*ConstBufferSequence] interface allows callers to send data from
memory-mapped regions (not possible in websocketpp). Callers can also memory-mapped regions (not possible in websocketpp). Callers can also