Update documentation

This commit is contained in:
Vinnie Falco
2019-07-06 12:04:52 -07:00
parent 8848ced9ab
commit 67452b23ff
17 changed files with 134 additions and 26 deletions

View File

@ -1,3 +1,9 @@
Version 263:
* Update documentation
--------------------------------------------------------------------------------
Version 262: Version 262:
* Fix deallocate in multi_buffer * Fix deallocate in multi_buffer

View File

@ -183,7 +183,7 @@ and illustrate the implementation of advanced features.
[/-----------------------------------------------------------------------------] [/-----------------------------------------------------------------------------]
[section:chat_server Chat Server __video__ __new__] [section:chat_server Chat Server __video__]
This example demonstrates a websocket chat server, allowing multiple This example demonstrates a websocket chat server, allowing multiple
users to connect and participate in live, group messaging. It comes users to connect and participate in live, group messaging. It comes

View File

@ -7,7 +7,7 @@
Official repository: https://github.com/boostorg/beast Official repository: https://github.com/boostorg/beast
] ]
[section:asio_refresher Refresher __new__] [section:asio_refresher Refresher]
To use Beast effectively, a prior understanding of Networking is required. To use Beast effectively, a prior understanding of Networking is required.
This section reviews these concepts as a reminder and guide for further This section reviews these concepts as a reminder and guide for further

View File

@ -7,7 +7,7 @@
Official repository: https://github.com/boostorg/beast Official repository: https://github.com/boostorg/beast
] ]
[section:timeouts Timeouts __example__ __new__] [section:timeouts Timeouts __example__]
Network programs must handle adverse connection conditions; the most common Network programs must handle adverse connection conditions; the most common
is that a connected peer goes offline unexpectedly. Protocols have no way of is that a connected peer goes offline unexpectedly. Protocols have no way of
@ -175,11 +175,7 @@ from asynchronous intermediate operations.
[/-----------------------------------------------------------------------------] [/-----------------------------------------------------------------------------]
[section:rate_limiting Rate Limiting __example__]
[/-----------------------------------------------------------------------------]
[section:rate_limiting Rate Limiting __example__ __new__]
The The
[link beast.ref.boost__beast__basic_stream `basic_stream`] [link beast.ref.boost__beast__basic_stream `basic_stream`]

View File

@ -7,7 +7,7 @@
Official repository: https://github.com/boostorg/beast Official repository: https://github.com/boostorg/beast
] ]
[section:layered_streams Layered Streams __new__] [section:layered_streams Layered Streams]
Networking's __ssl_stream__ is a class template meeting the requirements Networking's __ssl_stream__ is a class template meeting the requirements
of both synchronous and asynchronous read and write streams, implemented of both synchronous and asynchronous read and write streams, implemented
@ -114,7 +114,9 @@ facilities for authoring and working with layered streams:
]] ]]
] ]
[section Counted Stream __example__ __new__] [/-----------------------------------------------------------------------------]
[section Counted Stream __example__]
This example shows the definition of a layered stream which keeps individual This example shows the definition of a layered stream which keeps individual
counts of the total number of bytes read from and written to the next layer. counts of the total number of bytes read from and written to the next layer.
@ -125,4 +127,6 @@ streams:
[endsect] [endsect]
[/-----------------------------------------------------------------------------]
[endsect] [endsect]

View File

@ -7,7 +7,7 @@
Official repository: https://github.com/boostorg/beast Official repository: https://github.com/boostorg/beast
] ]
[section:echo Echo __example__ __new__] [section:echo Echo __example__]
This example develops an initiating function called [*echo]. This example develops an initiating function called [*echo].
The operation will read up to the first newline on a stream, and The operation will read up to the first newline on a stream, and

View File

@ -7,7 +7,7 @@
Official repository: https://github.com/boostorg/beast Official repository: https://github.com/boostorg/beast
] ]
[section:detect_ssl Detect SSL __example__ __new__] [section:detect_ssl Detect SSL __example__]
In this example we will build a simple function to detect the presence of the In this example we will build a simple function to detect the presence of the
[@https://tools.ietf.org/html/rfc2246#section-7.4 TLS client handshake] [@https://tools.ietf.org/html/rfc2246#section-7.4 TLS client handshake]

View File

@ -7,7 +7,7 @@
Official repository: https://github.com/boostorg/beast Official repository: https://github.com/boostorg/beast
] ]
[section:using_io Networking __new__] [section:using_io Networking]
This library uses the This library uses the
[@http://cplusplus.github.io/networking-ts/draft.pdf Networking Technical Specification], [@http://cplusplus.github.io/networking-ts/draft.pdf Networking Technical Specification],

View File

@ -7,7 +7,7 @@
Official repository: https://github.com/boostorg/beast Official repository: https://github.com/boostorg/beast
] ]
[section:establishing_connections Connecting __new__] [section:establishing_connections Connecting]
Before messages can be exchanged, a websocket stream first needs to be Before messages can be exchanged, a websocket stream first needs to be
connected, and then to have the websocket handshake performed. The stream connected, and then to have the websocket handshake performed. The stream

View File

@ -9,7 +9,7 @@
[/-----------------------------------------------------------------------------] [/-----------------------------------------------------------------------------]
[section:decorator Decorator __new__] [section:decorator Decorator]
For programs which need to modify either the outgoing WebSocket HTTP Upgrade For programs which need to modify either the outgoing WebSocket HTTP Upgrade
request, the outgoing WebSocket HTTP Upgrade response, or both, the stream request, the outgoing WebSocket HTTP Upgrade response, or both, the stream

View File

@ -9,7 +9,7 @@
[/-----------------------------------------------------------------------------] [/-----------------------------------------------------------------------------]
[section:messages Messages __new__] [section:messages Messages]
Once a websocket session is established, messages can be sent unsolicited by Once a websocket session is established, messages can be sent unsolicited by
either peer at any time. A message is made up of one or more ['messages frames]. either peer at any time. A message is made up of one or more ['messages frames].

View File

@ -9,7 +9,7 @@
[/-----------------------------------------------------------------------------] [/-----------------------------------------------------------------------------]
[section:timeouts Timeouts __new__] [section:timeouts Timeouts]
While While
[link beast.ref.boost__beast__basic_stream `basic_stream`] and [link beast.ref.boost__beast__basic_stream `basic_stream`] and

View File

@ -7,7 +7,7 @@
Official repository: https://github.com/boostorg/beast Official repository: https://github.com/boostorg/beast
] ]
[section:using_websocket WebSocket __new__] [section:using_websocket WebSocket]
[/-----------------------------------------------------------------------------] [/-----------------------------------------------------------------------------]

View File

@ -7,7 +7,7 @@
Official repository: https://github.com/boostorg/beast Official repository: https://github.com/boostorg/beast
] ]
[section:RatePolicy RatePolicy __new__] [section:RatePolicy RatePolicy]
An instance of [*RatePolicy] is associated with a An instance of [*RatePolicy] is associated with a
[link beast.ref.boost__beast__basic_stream `basic_stream`], [link beast.ref.boost__beast__basic_stream `basic_stream`],

View File

@ -170,9 +170,9 @@ __example__ contains example source code.
__video__ contains video presentation content __video__ contains video presentation content
[section:quickref Reference __new__] [section:quickref Reference]
__new__ indicates an item that is new in this version. __new__ indicates an item that was recently added.
[xinclude quickref.xml] [xinclude quickref.xml]
[endsect] [endsect]

View File

@ -9,6 +9,111 @@
[section Release Notes] [section Release Notes]
[/-----------------------------------------------------------------------------]
[heading Boost 1.71]
[*Improvements]
* [issue 1280] Add 1-element specialization for `buffers_cat`
* [issue 1556] Set parser status and flags even if body limit has been reached
* [issue 1567] Relax requirements for vector_body
* [issue 1568] `detect_ssl` uses `bool` instead of `tribool`
* [issue 1574] Replace `static_string` in HTTP parser
* [issue 1606] Use `steady_timer` type
* [issue 1611] Make chat websocket javascript client more user friendly
* [issue 1613] Remove redundant use of `static_string`
* [issue 1636] Improve performance of `http::string_to_verb`
* Preserve `operation_aborted` on partial message
* Remove unused `<experimental/unit_test/thread.hpp>`
* Reduce the number of instantiations of `filter_token_list`
* Add idle ping suspend test
* Remove the use of `bind_executor` in `basic_stream`
* Remove redundant template in service_base
* Remove the use of `static_string` from `http::fields`
* Enable split compilation in http::basic_fields
* Remove redundant instation of `static_string` in websocket
* Remove redundant use of `asio::coroutine` in `flat_stream`
* More split compilation in rfc7230.hpp
* More split compilation in websocket/detail/mask.hpp
* Simplify generation of sec-websocket-key
[*Fixes]
* [issue 1332] `allocator_traits::construct` is used for user-defined types
* [issue 1559] Member `get_executor` const-correctness
* [issue 1569] Fix `async_detect_ssl` handler type
* [issue 1570] Launder pointers
* [issue 1578] Fix min/max on MSVC
* [issue 1586] Fix uninitalized memory use in deflate_stream
* [issue 1593] Fix UB in websocket close tests
* [issue 1594] Fix data race in test stream
* [issue 1599] Fix moved-from executor in idle ping timeout
* [issue 1607] Remove uses of the deprecated `buffers` function
* [issue 1612] Remove uses of deprecated methods in websocket tests
* [issue 1620] Clean up typo in chat websocket javascript client
* [issue 1621] Fix `flat_buffer` copy members
* Silence gcc-8 warning
* Fix `buffers_cat` iterator tests
* Don't pessimize-move
* Qualify calls to `beast::iequals` in basic_parser.ipp
* Fix UB in websocket read tests
* Simplify websocket::detail::prng
* Don't over-allocate in http::basic_fields
[*Documentation]
* Documentation is built with SaxonHE instead of xsltproc
[/-----------------------------------------------------------------------------] [/-----------------------------------------------------------------------------]
[heading Boost 1.70] [heading Boost 1.70]
@ -17,10 +122,6 @@
The namespace alias `net` is used throughout for `boost::asio`. The namespace alias `net` is used throughout for `boost::asio`.
] ]
[/ includes up to version 209]
[*New Features] [*New Features]
* All composed operations use the new * All composed operations use the new

View File

@ -22,7 +22,8 @@ add_subdirectory (zlib)
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
GroupSources (include/boost/beast beast) GroupSources (include/boost/beast beast)
GroupSources (test/beast "/") GroupSources (test/extras/include/boost /)
GroupSources (test/beast /)
add_executable (tests-beast add_executable (tests-beast
${BOOST_BEAST_FILES} ${BOOST_BEAST_FILES}