ssl_stream and flat_stream are deprecated

This commit is contained in:
Mohammad Nejati
2024-05-30 11:51:55 +00:00
committed by Mohammad Nejati
parent 4089e27357
commit 9c7777e7f0
5 changed files with 7 additions and 21 deletions

View File

@ -72,13 +72,6 @@ facilities for authoring and working with layered streams:
customization point, allowing sockets to be closed in generic customization point, allowing sockets to be closed in generic
contexts in an extensible fashion. contexts in an extensible fashion.
]] ]]
[[
[link beast.ref.boost__beast__flat_stream `flat_stream`]
][
A flat stream operates as a transparent stream which helps to work around
a limitation of `net::ssl::stream`. It is used in the implementation
of [link beast.ref.boost__beast__ssl_stream `ssl_stream`].
]]
[[ [[
[link beast.ref.boost__beast__get_lowest_layer `get_lowest_layer`] [link beast.ref.boost__beast__get_lowest_layer `get_lowest_layer`]
][ ][
@ -105,13 +98,6 @@ facilities for authoring and working with layered streams:
of reference returned by of reference returned by
[link beast.ref.boost__beast__get_lowest_layer `get_lowest_layer`] [link beast.ref.boost__beast__get_lowest_layer `get_lowest_layer`]
]] ]]
[[
[link beast.ref.boost__beast__ssl_stream `ssl_stream`]
][
The SSL stream is a drop-in replacement for `net::ssl::stream` which
allows for move-construction and move-assignment, and also implements
a work-around for a performance limitation in the original SSL stream.
]]
] ]
[/-----------------------------------------------------------------------------] [/-----------------------------------------------------------------------------]

View File

@ -267,9 +267,7 @@ about Beast and other HTTP libraries that have gone through formal review.
(for example, a `boost::asio::ip::tcp::socket` or a (for example, a `boost::asio::ip::tcp::socket` or a
`boost::asio::ssl::stream`). You establish your TLS connection using the `boost::asio::ssl::stream`). You establish your TLS connection using the
interface on `ssl::stream` like shown in all of the Asio examples, then interface on `ssl::stream` like shown in all of the Asio examples, then
construct your `websocket::stream` around it. It works perfectly fine; construct your `websocket::stream` around it.
Beast comes with an `ssl_stream` wrapper in the example directory which
allows the SSL stream to be moved, overcoming an Asio limitation.
The WebSocket implementation [*does] provide support for shutting down The WebSocket implementation [*does] provide support for shutting down
the TLS connection through the use of the ADL compile-time virtual functions the TLS connection through the use of the ADL compile-time virtual functions

View File

@ -30,7 +30,7 @@
<member><link linkend="beast.ref.boost__beast__file_posix">file_posix</link></member> <member><link linkend="beast.ref.boost__beast__file_posix">file_posix</link></member>
<member><link linkend="beast.ref.boost__beast__file_stdio">file_stdio</link></member> <member><link linkend="beast.ref.boost__beast__file_stdio">file_stdio</link></member>
<member><link linkend="beast.ref.boost__beast__file_win32">file_win32</link></member> <member><link linkend="beast.ref.boost__beast__file_win32">file_win32</link></member>
<member><link linkend="beast.ref.boost__beast__flat_stream">flat_stream</link></member> <member><link linkend="beast.ref.boost__beast__flat_stream">flat_stream</link> (deprecated)</member>
<member><link linkend="beast.ref.boost__beast__iequal">iequal</link></member> <member><link linkend="beast.ref.boost__beast__iequal">iequal</link></member>
<member><link linkend="beast.ref.boost__beast__iless">iless</link></member> <member><link linkend="beast.ref.boost__beast__iless">iless</link></member>
<member><link linkend="beast.ref.boost__beast__rate_policy_access">rate_policy_access</link></member> <member><link linkend="beast.ref.boost__beast__rate_policy_access">rate_policy_access</link></member>
@ -87,7 +87,7 @@
</simplelist> </simplelist>
<bridgehead renderas="sect3">SSL</bridgehead> <bridgehead renderas="sect3">SSL</bridgehead>
<simplelist type="vert" columns="1"> <simplelist type="vert" columns="1">
<member><link linkend="beast.ref.boost__beast__ssl_stream">ssl_stream</link></member> <member><link linkend="beast.ref.boost__beast__ssl_stream">ssl_stream</link> (deprecated)</member>
</simplelist> </simplelist>
</entry> </entry>
<entry valign="top"> <entry valign="top">

View File

@ -22,7 +22,9 @@
namespace boost { namespace boost {
namespace beast { namespace beast {
/** Stream wrapper to improve write performance. /** (Deprecated: This wrapper is no longer needed; Asio linearizes
scatter/gather I/O in ssl::stream.) Stream wrapper to improve write
performance.
This wrapper flattens writes for buffer sequences having length This wrapper flattens writes for buffer sequences having length
greater than 1 and total size below a predefined amount, using greater than 1 and total size below a predefined amount, using

View File

@ -24,7 +24,7 @@
namespace boost { namespace boost {
namespace beast { namespace beast {
/** Provides stream-oriented functionality using OpenSSL /** (Deprecated: Use asio::ssl::stream instead.) Provides stream-oriented functionality using OpenSSL
*/ */
template<class NextLayer> template<class NextLayer>
struct ssl_stream : net::ssl::stream<NextLayer> struct ssl_stream : net::ssl::stream<NextLayer>