mirror of
https://github.com/boostorg/beast.git
synced 2025-07-30 21:07:26 +02:00
ssl_stream does not use flat_stream
We no longer need to use flat_stream to improve write performance, as
Asio now linearizes scatter/gather I/O in ssl::stream:
17637a48cc
This commit is contained in:
committed by
Mohammad Nejati
parent
6dd3cf7ab1
commit
bd804b6520
@ -213,7 +213,7 @@ fail(beast::error_code ec, char const* what)
|
|||||||
// Handles an HTTP server connection
|
// Handles an HTTP server connection
|
||||||
void
|
void
|
||||||
do_session(
|
do_session(
|
||||||
tcp::socket socket,
|
tcp::socket& socket,
|
||||||
ssl::context& ctx,
|
ssl::context& ctx,
|
||||||
std::shared_ptr<std::string const> const& doc_root)
|
std::shared_ptr<std::string const> const& doc_root)
|
||||||
{
|
{
|
||||||
@ -308,11 +308,11 @@ int main(int argc, char* argv[])
|
|||||||
acceptor.accept(socket);
|
acceptor.accept(socket);
|
||||||
|
|
||||||
// Launch the session, transferring ownership of the socket
|
// Launch the session, transferring ownership of the socket
|
||||||
std::thread{
|
std::thread{std::bind(
|
||||||
do_session,
|
&do_session,
|
||||||
std::move(socket),
|
std::move(socket),
|
||||||
std::ref(ctx),
|
std::ref(ctx),
|
||||||
doc_root}.detach();
|
doc_root)}.detach();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
catch (const std::exception& e)
|
catch (const std::exception& e)
|
||||||
|
@ -210,7 +210,7 @@ fail(beast::error_code ec, char const* what)
|
|||||||
// Handles an HTTP server connection
|
// Handles an HTTP server connection
|
||||||
void
|
void
|
||||||
do_session(
|
do_session(
|
||||||
tcp::socket socket,
|
tcp::socket& socket,
|
||||||
std::shared_ptr<std::string const> const& doc_root)
|
std::shared_ptr<std::string const> const& doc_root)
|
||||||
{
|
{
|
||||||
beast::error_code ec;
|
beast::error_code ec;
|
||||||
@ -287,10 +287,10 @@ int main(int argc, char* argv[])
|
|||||||
acceptor.accept(socket);
|
acceptor.accept(socket);
|
||||||
|
|
||||||
// Launch the session, transferring ownership of the socket
|
// Launch the session, transferring ownership of the socket
|
||||||
std::thread{
|
std::thread{std::bind(
|
||||||
do_session,
|
&do_session,
|
||||||
std::move(socket),
|
std::move(socket),
|
||||||
doc_root}.detach();
|
doc_root)}.detach();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
catch (const std::exception& e)
|
catch (const std::exception& e)
|
||||||
|
@ -80,7 +80,7 @@ setup_stream(websocket::stream<NextLayer>& ws)
|
|||||||
//------------------------------------------------------------------------------
|
//------------------------------------------------------------------------------
|
||||||
|
|
||||||
void
|
void
|
||||||
do_sync_session(websocket::stream<beast::tcp_stream> ws)
|
do_sync_session(websocket::stream<beast::tcp_stream>& ws)
|
||||||
{
|
{
|
||||||
beast::error_code ec;
|
beast::error_code ec;
|
||||||
|
|
||||||
@ -129,10 +129,10 @@ do_sync_listen(
|
|||||||
if(ec)
|
if(ec)
|
||||||
return fail(ec, "accept");
|
return fail(ec, "accept");
|
||||||
|
|
||||||
std::thread{
|
std::thread(std::bind(
|
||||||
do_sync_session,
|
&do_sync_session,
|
||||||
websocket::stream<beast::tcp_stream>(std::move(socket))
|
websocket::stream<beast::tcp_stream>(
|
||||||
}.detach();
|
std::move(socket)))).detach();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -441,11 +441,13 @@ int main(int argc, char* argv[])
|
|||||||
net::io_context ioc{threads};
|
net::io_context ioc{threads};
|
||||||
|
|
||||||
// Create sync port
|
// Create sync port
|
||||||
std::thread{
|
std::thread(beast::bind_front_handler(
|
||||||
do_sync_listen,
|
&do_sync_listen,
|
||||||
std::ref(ioc),
|
std::ref(ioc),
|
||||||
tcp::endpoint{address, static_cast<unsigned short>(port + 0u)}
|
tcp::endpoint{
|
||||||
}.detach();
|
address,
|
||||||
|
static_cast<unsigned short>(port + 0u)}
|
||||||
|
)).detach();
|
||||||
|
|
||||||
// Create async port
|
// Create async port
|
||||||
std::make_shared<async_listener>(
|
std::make_shared<async_listener>(
|
||||||
|
@ -123,10 +123,10 @@ int main(int argc, char* argv[])
|
|||||||
acceptor.accept(socket);
|
acceptor.accept(socket);
|
||||||
|
|
||||||
// Launch the session, transferring ownership of the socket
|
// Launch the session, transferring ownership of the socket
|
||||||
std::thread{
|
std::thread(
|
||||||
do_session,
|
&do_session,
|
||||||
std::move(socket),
|
std::move(socket),
|
||||||
std::ref(ctx)}.detach();
|
std::ref(ctx)).detach();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
catch (const std::exception& e)
|
catch (const std::exception& e)
|
||||||
|
@ -108,9 +108,9 @@ int main(int argc, char* argv[])
|
|||||||
acceptor.accept(socket);
|
acceptor.accept(socket);
|
||||||
|
|
||||||
// Launch the session, transferring ownership of the socket
|
// Launch the session, transferring ownership of the socket
|
||||||
std::thread{
|
std::thread(
|
||||||
do_session,
|
&do_session,
|
||||||
std::move(socket)}.detach();
|
std::move(socket)).detach();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
catch (const std::exception& e)
|
catch (const std::exception& e)
|
||||||
|
@ -15,672 +15,21 @@
|
|||||||
// This include is necessary to work with `ssl::stream` and `boost::beast::websocket::stream`
|
// This include is necessary to work with `ssl::stream` and `boost::beast::websocket::stream`
|
||||||
#include <boost/beast/websocket/ssl.hpp>
|
#include <boost/beast/websocket/ssl.hpp>
|
||||||
|
|
||||||
#include <boost/beast/core/flat_stream.hpp>
|
|
||||||
|
|
||||||
// VFALCO We include this because anyone who uses ssl will
|
// VFALCO We include this because anyone who uses ssl will
|
||||||
// very likely need to check for ssl::error::stream_truncated
|
// very likely need to check for ssl::error::stream_truncated
|
||||||
#include <boost/asio/ssl/error.hpp>
|
#include <boost/asio/ssl/error.hpp>
|
||||||
|
|
||||||
#include <boost/asio/ssl/stream.hpp>
|
#include <boost/asio/ssl/stream.hpp>
|
||||||
#include <cstddef>
|
|
||||||
#include <memory>
|
|
||||||
#include <type_traits>
|
|
||||||
#include <utility>
|
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
namespace beast {
|
namespace beast {
|
||||||
|
|
||||||
/** Provides stream-oriented functionality using OpenSSL
|
/** Provides stream-oriented functionality using OpenSSL
|
||||||
|
|
||||||
The stream class template provides asynchronous and blocking
|
|
||||||
stream-oriented functionality using SSL.
|
|
||||||
|
|
||||||
@par Thread Safety
|
|
||||||
@e Distinct @e objects: Safe.@n
|
|
||||||
@e Shared @e objects: Unsafe. The application must also ensure that all
|
|
||||||
asynchronous operations are performed within the same implicit or explicit
|
|
||||||
strand.
|
|
||||||
|
|
||||||
@par Example
|
|
||||||
To use this template with a @ref tcp_stream, you would write:
|
|
||||||
@code
|
|
||||||
net::io_context ioc;
|
|
||||||
net::ssl::context ctx{net::ssl::context::tlsv12};
|
|
||||||
beast::ssl_stream<beast::tcp_stream> sock{ioc, ctx};
|
|
||||||
@endcode
|
|
||||||
|
|
||||||
In addition to providing an interface identical to `net::ssl::stream`,
|
|
||||||
the wrapper has the following additional properties:
|
|
||||||
|
|
||||||
@li Satisfies @b MoveConstructible
|
|
||||||
|
|
||||||
@li Satisfies @b MoveAssignable
|
|
||||||
|
|
||||||
@li Constructible from a moved socket.
|
|
||||||
|
|
||||||
@li Uses @ref flat_stream internally, as a performance work-around for a
|
|
||||||
limitation of `net::ssl::stream` when writing buffer sequences
|
|
||||||
having length greater than one.
|
|
||||||
|
|
||||||
@par Concepts:
|
|
||||||
@li AsyncReadStream
|
|
||||||
@li AsyncWriteStream
|
|
||||||
@li Stream
|
|
||||||
@li SyncReadStream
|
|
||||||
@li SyncWriteStream
|
|
||||||
*/
|
*/
|
||||||
template<class NextLayer>
|
template<class NextLayer>
|
||||||
class ssl_stream
|
struct ssl_stream : net::ssl::stream<NextLayer>
|
||||||
: public net::ssl::stream_base
|
|
||||||
{
|
{
|
||||||
using ssl_stream_type = net::ssl::stream<NextLayer>;
|
using net::ssl::stream<NextLayer>::stream;
|
||||||
using stream_type = boost::beast::flat_stream<ssl_stream_type>;
|
|
||||||
|
|
||||||
std::unique_ptr<stream_type> p_;
|
|
||||||
|
|
||||||
public:
|
|
||||||
/// The native handle type of the SSL stream.
|
|
||||||
using native_handle_type =
|
|
||||||
typename ssl_stream_type::native_handle_type;
|
|
||||||
|
|
||||||
/// Structure for use with deprecated impl_type.
|
|
||||||
using impl_struct = typename ssl_stream_type::impl_struct;
|
|
||||||
|
|
||||||
/// The type of the next layer.
|
|
||||||
using next_layer_type = typename ssl_stream_type::next_layer_type;
|
|
||||||
|
|
||||||
/// The type of the executor associated with the object.
|
|
||||||
using executor_type = typename stream_type::executor_type;
|
|
||||||
|
|
||||||
/// Rebinds the stream type to another executor.
|
|
||||||
template<class Executor1>
|
|
||||||
struct rebind_executor
|
|
||||||
{
|
|
||||||
/// The stream type when rebound to the specified executor.
|
|
||||||
using other = ssl_stream<
|
|
||||||
typename stream_type::template rebind_executor<Executor1>::other
|
|
||||||
>;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
/** Construct a stream.
|
|
||||||
|
|
||||||
This constructor creates a stream and initialises the underlying stream
|
|
||||||
object.
|
|
||||||
|
|
||||||
@param arg The argument to be passed to initialise the underlying stream.
|
|
||||||
|
|
||||||
@param ctx The SSL context to be used for the stream.
|
|
||||||
*/
|
|
||||||
template<class Arg>
|
|
||||||
ssl_stream(
|
|
||||||
Arg&& arg,
|
|
||||||
net::ssl::context& ctx)
|
|
||||||
: p_(new stream_type{
|
|
||||||
std::forward<Arg>(arg), ctx})
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Get the executor associated with the object.
|
|
||||||
|
|
||||||
This function may be used to obtain the executor object that the stream
|
|
||||||
uses to dispatch handlers for asynchronous operations.
|
|
||||||
|
|
||||||
@return A copy of the executor that stream will use to dispatch handlers.
|
|
||||||
*/
|
|
||||||
executor_type
|
|
||||||
get_executor() noexcept
|
|
||||||
{
|
|
||||||
return p_->get_executor();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Get the underlying implementation in the native type.
|
|
||||||
|
|
||||||
This function may be used to obtain the underlying implementation of the
|
|
||||||
context. This is intended to allow access to context functionality that is
|
|
||||||
not otherwise provided.
|
|
||||||
|
|
||||||
@par Example
|
|
||||||
The native_handle() function returns a pointer of type @c SSL* that is
|
|
||||||
suitable for passing to functions such as @c SSL_get_verify_result and
|
|
||||||
@c SSL_get_peer_certificate:
|
|
||||||
@code
|
|
||||||
boost::beast::ssl_stream<net::ip::tcp::socket> ss{ioc, ctx};
|
|
||||||
|
|
||||||
// ... establish connection and perform handshake ...
|
|
||||||
|
|
||||||
if (X509* cert = SSL_get_peer_certificate(ss.native_handle()))
|
|
||||||
{
|
|
||||||
if (SSL_get_verify_result(ss.native_handle()) == X509_V_OK)
|
|
||||||
{
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@endcode
|
|
||||||
*/
|
|
||||||
native_handle_type
|
|
||||||
native_handle() noexcept
|
|
||||||
{
|
|
||||||
return p_->next_layer().native_handle();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Get a reference to the next layer.
|
|
||||||
|
|
||||||
This function returns a reference to the next layer in a stack of stream
|
|
||||||
layers.
|
|
||||||
|
|
||||||
@note The next layer is the wrapped stream and not the @ref flat_stream
|
|
||||||
used in the implementation.
|
|
||||||
|
|
||||||
@return A reference to the next layer in the stack of stream layers.
|
|
||||||
Ownership is not transferred to the caller.
|
|
||||||
*/
|
|
||||||
next_layer_type const&
|
|
||||||
next_layer() const noexcept
|
|
||||||
{
|
|
||||||
return p_->next_layer().next_layer();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Get a reference to the next layer.
|
|
||||||
|
|
||||||
This function returns a reference to the next layer in a stack of stream
|
|
||||||
layers.
|
|
||||||
|
|
||||||
@note The next layer is the wrapped stream and not the @ref flat_stream
|
|
||||||
used in the implementation.
|
|
||||||
|
|
||||||
@return A reference to the next layer in the stack of stream layers.
|
|
||||||
Ownership is not transferred to the caller.
|
|
||||||
*/
|
|
||||||
next_layer_type&
|
|
||||||
next_layer() noexcept
|
|
||||||
{
|
|
||||||
return p_->next_layer().next_layer();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Set the peer verification mode.
|
|
||||||
|
|
||||||
This function may be used to configure the peer verification mode used by
|
|
||||||
the stream. The new mode will override the mode inherited from the context.
|
|
||||||
|
|
||||||
@param v A bitmask of peer verification modes.
|
|
||||||
|
|
||||||
@throws boost::system::system_error Thrown on failure.
|
|
||||||
|
|
||||||
@note Calls @c SSL_set_verify.
|
|
||||||
*/
|
|
||||||
void
|
|
||||||
set_verify_mode(net::ssl::verify_mode v)
|
|
||||||
{
|
|
||||||
p_->next_layer().set_verify_mode(v);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Set the peer verification mode.
|
|
||||||
|
|
||||||
This function may be used to configure the peer verification mode used by
|
|
||||||
the stream. The new mode will override the mode inherited from the context.
|
|
||||||
|
|
||||||
@param v A bitmask of peer verification modes. See `verify_mode` for
|
|
||||||
available values.
|
|
||||||
|
|
||||||
@param ec Set to indicate what error occurred, if any.
|
|
||||||
|
|
||||||
@note Calls @c SSL_set_verify.
|
|
||||||
*/
|
|
||||||
void
|
|
||||||
set_verify_mode(net::ssl::verify_mode v,
|
|
||||||
boost::system::error_code& ec)
|
|
||||||
{
|
|
||||||
p_->next_layer().set_verify_mode(v, ec);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Set the peer verification depth.
|
|
||||||
|
|
||||||
This function may be used to configure the maximum verification depth
|
|
||||||
allowed by the stream.
|
|
||||||
|
|
||||||
@param depth Maximum depth for the certificate chain verification that
|
|
||||||
shall be allowed.
|
|
||||||
|
|
||||||
@throws boost::system::system_error Thrown on failure.
|
|
||||||
|
|
||||||
@note Calls @c SSL_set_verify_depth.
|
|
||||||
*/
|
|
||||||
void
|
|
||||||
set_verify_depth(int depth)
|
|
||||||
{
|
|
||||||
p_->next_layer().set_verify_depth(depth);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Set the peer verification depth.
|
|
||||||
|
|
||||||
This function may be used to configure the maximum verification depth
|
|
||||||
allowed by the stream.
|
|
||||||
|
|
||||||
@param depth Maximum depth for the certificate chain verification that
|
|
||||||
shall be allowed.
|
|
||||||
|
|
||||||
@param ec Set to indicate what error occurred, if any.
|
|
||||||
|
|
||||||
@note Calls @c SSL_set_verify_depth.
|
|
||||||
*/
|
|
||||||
void
|
|
||||||
set_verify_depth(
|
|
||||||
int depth, boost::system::error_code& ec)
|
|
||||||
{
|
|
||||||
p_->next_layer().set_verify_depth(depth, ec);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Set the callback used to verify peer certificates.
|
|
||||||
|
|
||||||
This function is used to specify a callback function that will be called
|
|
||||||
by the implementation when it needs to verify a peer certificate.
|
|
||||||
|
|
||||||
@param callback The function object to be used for verifying a certificate.
|
|
||||||
The function signature of the handler must be:
|
|
||||||
@code bool verify_callback(
|
|
||||||
bool preverified, // True if the certificate passed pre-verification.
|
|
||||||
verify_context& ctx // The peer certificate and other context.
|
|
||||||
); @endcode
|
|
||||||
The return value of the callback is true if the certificate has passed
|
|
||||||
verification, false otherwise.
|
|
||||||
|
|
||||||
@throws boost::system::system_error Thrown on failure.
|
|
||||||
|
|
||||||
@note Calls @c SSL_set_verify.
|
|
||||||
*/
|
|
||||||
template<class VerifyCallback>
|
|
||||||
void
|
|
||||||
set_verify_callback(VerifyCallback callback)
|
|
||||||
{
|
|
||||||
p_->next_layer().set_verify_callback(callback);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Set the callback used to verify peer certificates.
|
|
||||||
|
|
||||||
This function is used to specify a callback function that will be called
|
|
||||||
by the implementation when it needs to verify a peer certificate.
|
|
||||||
|
|
||||||
@param callback The function object to be used for verifying a certificate.
|
|
||||||
The function signature of the handler must be:
|
|
||||||
@code bool verify_callback(
|
|
||||||
bool preverified, // True if the certificate passed pre-verification.
|
|
||||||
net::verify_context& ctx // The peer certificate and other context.
|
|
||||||
); @endcode
|
|
||||||
The return value of the callback is true if the certificate has passed
|
|
||||||
verification, false otherwise.
|
|
||||||
|
|
||||||
@param ec Set to indicate what error occurred, if any.
|
|
||||||
|
|
||||||
@note Calls @c SSL_set_verify.
|
|
||||||
*/
|
|
||||||
template<class VerifyCallback>
|
|
||||||
void
|
|
||||||
set_verify_callback(VerifyCallback callback,
|
|
||||||
boost::system::error_code& ec)
|
|
||||||
{
|
|
||||||
p_->next_layer().set_verify_callback(callback, ec);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Perform SSL handshaking.
|
|
||||||
|
|
||||||
This function is used to perform SSL handshaking on the stream. The
|
|
||||||
function call will block until handshaking is complete or an error occurs.
|
|
||||||
|
|
||||||
@param type The type of handshaking to be performed, i.e. as a client or as
|
|
||||||
a server.
|
|
||||||
|
|
||||||
@throws boost::system::system_error Thrown on failure.
|
|
||||||
*/
|
|
||||||
void
|
|
||||||
handshake(handshake_type type)
|
|
||||||
{
|
|
||||||
p_->next_layer().handshake(type);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Perform SSL handshaking.
|
|
||||||
|
|
||||||
This function is used to perform SSL handshaking on the stream. The
|
|
||||||
function call will block until handshaking is complete or an error occurs.
|
|
||||||
|
|
||||||
@param type The type of handshaking to be performed, i.e. as a client or as
|
|
||||||
a server.
|
|
||||||
|
|
||||||
@param ec Set to indicate what error occurred, if any.
|
|
||||||
*/
|
|
||||||
void
|
|
||||||
handshake(handshake_type type,
|
|
||||||
boost::system::error_code& ec)
|
|
||||||
{
|
|
||||||
p_->next_layer().handshake(type, ec);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Perform SSL handshaking.
|
|
||||||
|
|
||||||
This function is used to perform SSL handshaking on the stream. The
|
|
||||||
function call will block until handshaking is complete or an error occurs.
|
|
||||||
|
|
||||||
@param type The type of handshaking to be performed, i.e. as a client or as
|
|
||||||
a server.
|
|
||||||
|
|
||||||
@param buffers The buffered data to be reused for the handshake.
|
|
||||||
|
|
||||||
@throws boost::system::system_error Thrown on failure.
|
|
||||||
*/
|
|
||||||
template<class ConstBufferSequence>
|
|
||||||
void
|
|
||||||
handshake(
|
|
||||||
handshake_type type, ConstBufferSequence const& buffers)
|
|
||||||
{
|
|
||||||
p_->next_layer().handshake(type, buffers);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Perform SSL handshaking.
|
|
||||||
|
|
||||||
This function is used to perform SSL handshaking on the stream. The
|
|
||||||
function call will block until handshaking is complete or an error occurs.
|
|
||||||
|
|
||||||
@param type The type of handshaking to be performed, i.e. as a client or as
|
|
||||||
a server.
|
|
||||||
|
|
||||||
@param buffers The buffered data to be reused for the handshake.
|
|
||||||
|
|
||||||
@param ec Set to indicate what error occurred, if any.
|
|
||||||
*/
|
|
||||||
template<class ConstBufferSequence>
|
|
||||||
void
|
|
||||||
handshake(handshake_type type,
|
|
||||||
ConstBufferSequence const& buffers,
|
|
||||||
boost::system::error_code& ec)
|
|
||||||
{
|
|
||||||
p_->next_layer().handshake(type, buffers, ec);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Start an asynchronous SSL handshake.
|
|
||||||
|
|
||||||
This function is used to asynchronously perform an SSL handshake on the
|
|
||||||
stream. This function call always returns immediately.
|
|
||||||
|
|
||||||
@param type The type of handshaking to be performed, i.e. as a client or as
|
|
||||||
a server.
|
|
||||||
|
|
||||||
@param handler The handler to be called when the handshake operation
|
|
||||||
completes. Copies will be made of the handler as required. The equivalent
|
|
||||||
function signature of the handler must be:
|
|
||||||
@code void handler(
|
|
||||||
const boost::system::error_code& error // Result of operation.
|
|
||||||
); @endcode
|
|
||||||
*/
|
|
||||||
template<BOOST_BEAST_ASYNC_TPARAM1 HandshakeHandler = net::default_completion_token_t<executor_type>>
|
|
||||||
BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(HandshakeHandler, void(boost::system::error_code))
|
|
||||||
async_handshake(handshake_type type,
|
|
||||||
BOOST_ASIO_MOVE_ARG(HandshakeHandler) handler = net::default_completion_token_t<executor_type>{})
|
|
||||||
{
|
|
||||||
return p_->next_layer().async_handshake(type,
|
|
||||||
BOOST_ASIO_MOVE_CAST(HandshakeHandler)(handler));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Start an asynchronous SSL handshake.
|
|
||||||
|
|
||||||
This function is used to asynchronously perform an SSL handshake on the
|
|
||||||
stream. This function call always returns immediately.
|
|
||||||
|
|
||||||
@param type The type of handshaking to be performed, i.e. as a client or as
|
|
||||||
a server.
|
|
||||||
|
|
||||||
@param buffers The buffered data to be reused for the handshake. Although
|
|
||||||
the buffers object may be copied as necessary, ownership of the underlying
|
|
||||||
buffers is retained by the caller, which must guarantee that they remain
|
|
||||||
valid until the handler is called.
|
|
||||||
|
|
||||||
@param handler The handler to be called when the handshake operation
|
|
||||||
completes. Copies will be made of the handler as required. The equivalent
|
|
||||||
function signature of the handler must be:
|
|
||||||
@code void handler(
|
|
||||||
const boost::system::error_code& error, // Result of operation.
|
|
||||||
std::size_t bytes_transferred // Amount of buffers used in handshake.
|
|
||||||
); @endcode
|
|
||||||
*/
|
|
||||||
template<class ConstBufferSequence,
|
|
||||||
BOOST_BEAST_ASYNC_TPARAM2 BufferedHandshakeHandler = net::default_completion_token_t<executor_type>>
|
|
||||||
BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(BufferedHandshakeHandler, void(boost::system::error_code, std::size_t))
|
|
||||||
async_handshake(handshake_type type, ConstBufferSequence const& buffers,
|
|
||||||
BOOST_ASIO_MOVE_ARG(BufferedHandshakeHandler) handler
|
|
||||||
= net::default_completion_token_t<executor_type>{})
|
|
||||||
{
|
|
||||||
return p_->next_layer().async_handshake(type, buffers,
|
|
||||||
BOOST_ASIO_MOVE_CAST(BufferedHandshakeHandler)(handler));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Shut down SSL on the stream.
|
|
||||||
|
|
||||||
This function is used to shut down SSL on the stream. The function call
|
|
||||||
will block until SSL has been shut down or an error occurs.
|
|
||||||
|
|
||||||
@throws boost::system::system_error Thrown on failure.
|
|
||||||
*/
|
|
||||||
void
|
|
||||||
shutdown()
|
|
||||||
{
|
|
||||||
p_->next_layer().shutdown();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Shut down SSL on the stream.
|
|
||||||
|
|
||||||
This function is used to shut down SSL on the stream. The function call
|
|
||||||
will block until SSL has been shut down or an error occurs.
|
|
||||||
|
|
||||||
@param ec Set to indicate what error occurred, if any.
|
|
||||||
*/
|
|
||||||
void
|
|
||||||
shutdown(boost::system::error_code& ec)
|
|
||||||
{
|
|
||||||
p_->next_layer().shutdown(ec);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Asynchronously shut down SSL on the stream.
|
|
||||||
|
|
||||||
This function is used to asynchronously shut down SSL on the stream. This
|
|
||||||
function call always returns immediately.
|
|
||||||
|
|
||||||
@param handler The handler to be called when the handshake operation
|
|
||||||
completes. Copies will be made of the handler as required. The equivalent
|
|
||||||
function signature of the handler must be:
|
|
||||||
@code void handler(
|
|
||||||
const boost::system::error_code& error // Result of operation.
|
|
||||||
); @endcode
|
|
||||||
*/
|
|
||||||
template<BOOST_BEAST_ASYNC_TPARAM1 ShutdownHandler = net::default_completion_token_t<executor_type>>
|
|
||||||
BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(ShutdownHandler, void(boost::system::error_code))
|
|
||||||
async_shutdown(BOOST_ASIO_MOVE_ARG(ShutdownHandler) handler = net::default_completion_token_t<executor_type>{})
|
|
||||||
{
|
|
||||||
return p_->next_layer().async_shutdown(
|
|
||||||
BOOST_ASIO_MOVE_CAST(ShutdownHandler)(handler));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Write some data to the stream.
|
|
||||||
|
|
||||||
This function is used to write data on the stream. The function call will
|
|
||||||
block until one or more bytes of data has been written successfully, or
|
|
||||||
until an error occurs.
|
|
||||||
|
|
||||||
@param buffers The data to be written.
|
|
||||||
|
|
||||||
@returns The number of bytes written.
|
|
||||||
|
|
||||||
@throws boost::system::system_error Thrown on failure.
|
|
||||||
|
|
||||||
@note The `write_some` operation may not transmit all of the data to the
|
|
||||||
peer. Consider using the `net::write` function if you need to
|
|
||||||
ensure that all data is written before the blocking operation completes.
|
|
||||||
*/
|
|
||||||
template<class ConstBufferSequence>
|
|
||||||
std::size_t
|
|
||||||
write_some(ConstBufferSequence const& buffers)
|
|
||||||
{
|
|
||||||
return p_->write_some(buffers);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Write some data to the stream.
|
|
||||||
|
|
||||||
This function is used to write data on the stream. The function call will
|
|
||||||
block until one or more bytes of data has been written successfully, or
|
|
||||||
until an error occurs.
|
|
||||||
|
|
||||||
@param buffers The data to be written to the stream.
|
|
||||||
|
|
||||||
@param ec Set to indicate what error occurred, if any.
|
|
||||||
|
|
||||||
@returns The number of bytes written. Returns 0 if an error occurred.
|
|
||||||
|
|
||||||
@note The `write_some` operation may not transmit all of the data to the
|
|
||||||
peer. Consider using the `net::write` function if you need to
|
|
||||||
ensure that all data is written before the blocking operation completes.
|
|
||||||
*/
|
|
||||||
template<class ConstBufferSequence>
|
|
||||||
std::size_t
|
|
||||||
write_some(ConstBufferSequence const& buffers,
|
|
||||||
boost::system::error_code& ec)
|
|
||||||
{
|
|
||||||
return p_->write_some(buffers, ec);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Start an asynchronous write.
|
|
||||||
|
|
||||||
This function is used to asynchronously write one or more bytes of data to
|
|
||||||
the stream. The function call always returns immediately.
|
|
||||||
|
|
||||||
@param buffers The data to be written to the stream. Although the buffers
|
|
||||||
object may be copied as necessary, ownership of the underlying buffers is
|
|
||||||
retained by the caller, which must guarantee that they remain valid until
|
|
||||||
the handler is called.
|
|
||||||
|
|
||||||
@param handler The handler to be called when the write operation completes.
|
|
||||||
Copies will be made of the handler as required. The equivalent function
|
|
||||||
signature of the handler must be:
|
|
||||||
@code void handler(
|
|
||||||
const boost::system::error_code& error, // Result of operation.
|
|
||||||
std::size_t bytes_transferred // Number of bytes written.
|
|
||||||
); @endcode
|
|
||||||
|
|
||||||
@note The `async_write_some` operation may not transmit all of the data to
|
|
||||||
the peer. Consider using the `net::async_write` function if you
|
|
||||||
need to ensure that all data is written before the asynchronous operation
|
|
||||||
completes.
|
|
||||||
*/
|
|
||||||
template<class ConstBufferSequence,
|
|
||||||
BOOST_BEAST_ASYNC_TPARAM2 WriteHandler = net::default_completion_token_t<executor_type>>
|
|
||||||
BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(WriteHandler, void(boost::system::error_code, std::size_t))
|
|
||||||
async_write_some(ConstBufferSequence const& buffers,
|
|
||||||
BOOST_ASIO_MOVE_ARG(WriteHandler) handler= net::default_completion_token_t<executor_type>{})
|
|
||||||
{
|
|
||||||
return p_->async_write_some(buffers,
|
|
||||||
BOOST_ASIO_MOVE_CAST(WriteHandler)(handler));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Read some data from the stream.
|
|
||||||
|
|
||||||
This function is used to read data from the stream. The function call will
|
|
||||||
block until one or more bytes of data has been read successfully, or until
|
|
||||||
an error occurs.
|
|
||||||
|
|
||||||
@param buffers The buffers into which the data will be read.
|
|
||||||
|
|
||||||
@returns The number of bytes read.
|
|
||||||
|
|
||||||
@throws boost::system::system_error Thrown on failure.
|
|
||||||
|
|
||||||
@note The `read_some` operation may not read all of the requested number of
|
|
||||||
bytes. Consider using the `net::read` function if you need to ensure
|
|
||||||
that the requested amount of data is read before the blocking operation
|
|
||||||
completes.
|
|
||||||
*/
|
|
||||||
template<class MutableBufferSequence>
|
|
||||||
std::size_t
|
|
||||||
read_some(MutableBufferSequence const& buffers)
|
|
||||||
{
|
|
||||||
return p_->read_some(buffers);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Read some data from the stream.
|
|
||||||
|
|
||||||
This function is used to read data from the stream. The function call will
|
|
||||||
block until one or more bytes of data has been read successfully, or until
|
|
||||||
an error occurs.
|
|
||||||
|
|
||||||
@param buffers The buffers into which the data will be read.
|
|
||||||
|
|
||||||
@param ec Set to indicate what error occurred, if any.
|
|
||||||
|
|
||||||
@returns The number of bytes read. Returns 0 if an error occurred.
|
|
||||||
|
|
||||||
@note The `read_some` operation may not read all of the requested number of
|
|
||||||
bytes. Consider using the `net::read` function if you need to ensure
|
|
||||||
that the requested amount of data is read before the blocking operation
|
|
||||||
completes.
|
|
||||||
*/
|
|
||||||
template<class MutableBufferSequence>
|
|
||||||
std::size_t
|
|
||||||
read_some(MutableBufferSequence const& buffers,
|
|
||||||
boost::system::error_code& ec)
|
|
||||||
{
|
|
||||||
return p_->read_some(buffers, ec);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Start an asynchronous read.
|
|
||||||
|
|
||||||
This function is used to asynchronously read one or more bytes of data from
|
|
||||||
the stream. The function call always returns immediately.
|
|
||||||
|
|
||||||
@param buffers The buffers into which the data will be read. Although the
|
|
||||||
buffers object may be copied as necessary, ownership of the underlying
|
|
||||||
buffers is retained by the caller, which must guarantee that they remain
|
|
||||||
valid until the handler is called.
|
|
||||||
|
|
||||||
@param handler The handler to be called when the read operation completes.
|
|
||||||
Copies will be made of the handler as required. The equivalent function
|
|
||||||
signature of the handler must be:
|
|
||||||
@code void handler(
|
|
||||||
const boost::system::error_code& error, // Result of operation.
|
|
||||||
std::size_t bytes_transferred // Number of bytes read.
|
|
||||||
); @endcode
|
|
||||||
|
|
||||||
@note The `async_read_some` operation may not read all of the requested
|
|
||||||
number of bytes. Consider using the `net::async_read` function
|
|
||||||
if you need to ensure that the requested amount of data is read before
|
|
||||||
the asynchronous operation completes.
|
|
||||||
*/
|
|
||||||
template<class MutableBufferSequence,
|
|
||||||
BOOST_BEAST_ASYNC_TPARAM2 ReadHandler = net::default_completion_token_t<executor_type>>
|
|
||||||
BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(ReadHandler, void(boost::system::error_code, std::size_t))
|
|
||||||
async_read_some(MutableBufferSequence const& buffers,
|
|
||||||
BOOST_ASIO_MOVE_ARG(ReadHandler) handler
|
|
||||||
= net::default_completion_token_t<executor_type>{})
|
|
||||||
{
|
|
||||||
return p_->async_read_some(buffers,
|
|
||||||
BOOST_ASIO_MOVE_CAST(ReadHandler)(handler));
|
|
||||||
}
|
|
||||||
|
|
||||||
// These hooks are used to inform boost::beast::websocket::stream on
|
|
||||||
// how to tear down the connection as part of the WebSocket
|
|
||||||
// protocol specifications
|
|
||||||
#if ! BOOST_BEAST_DOXYGEN
|
|
||||||
template<class SyncStream>
|
|
||||||
friend
|
|
||||||
void
|
|
||||||
teardown(
|
|
||||||
boost::beast::role_type role,
|
|
||||||
ssl_stream<SyncStream>& stream,
|
|
||||||
boost::system::error_code& ec);
|
|
||||||
|
|
||||||
template<class AsyncStream, typename TeardownHandler>
|
|
||||||
friend
|
|
||||||
void
|
|
||||||
async_teardown(
|
|
||||||
boost::beast::role_type role,
|
|
||||||
ssl_stream<AsyncStream>& stream,
|
|
||||||
TeardownHandler&& handler);
|
|
||||||
#endif
|
|
||||||
};
|
};
|
||||||
|
|
||||||
#if ! BOOST_BEAST_DOXYGEN
|
#if ! BOOST_BEAST_DOXYGEN
|
||||||
@ -693,7 +42,7 @@ teardown(
|
|||||||
{
|
{
|
||||||
// Just forward it to the underlying ssl::stream
|
// Just forward it to the underlying ssl::stream
|
||||||
using boost::beast::websocket::teardown;
|
using boost::beast::websocket::teardown;
|
||||||
teardown(role, *stream.p_, ec);
|
teardown(role, static_cast<net::ssl::stream<SyncStream>&>(stream), ec);
|
||||||
}
|
}
|
||||||
|
|
||||||
template<class AsyncStream,
|
template<class AsyncStream,
|
||||||
@ -706,7 +55,7 @@ async_teardown(
|
|||||||
{
|
{
|
||||||
// Just forward it to the underlying ssl::stream
|
// Just forward it to the underlying ssl::stream
|
||||||
using boost::beast::websocket::async_teardown;
|
using boost::beast::websocket::async_teardown;
|
||||||
async_teardown(role, *stream.p_,
|
async_teardown(role, static_cast<net::ssl::stream<AsyncStream>&>(stream),
|
||||||
std::forward<TeardownHandler>(handler));
|
std::forward<TeardownHandler>(handler));
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
Reference in New Issue
Block a user