forked from boostorg/beast
19f15046b0
This solves a problem where clang and gcc locate the deleted version of teardown and async_teardown instead of the overloaded version. It requires overloads to add `teardown_tag` into the signature so that the rules for argument dependent lookup can find the right function. Improve documentation of teardown requirements The documentation is updated to clearly explain the need for including <beast/websocket/ssl.hpp> to use SSL streams with WebSocket. The default implementations of teardown and async_teardown now use static_assert to alert the user of improper usage, with comments providing guidance for resolving the error.
75 lines
2.3 KiB
C++
75 lines
2.3 KiB
C++
//
|
|
// Copyright (c) 2013-2016 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)
|
|
//
|
|
|
|
#ifndef BEAST_WEBSOCKET_SSL_HPP
|
|
#define BEAST_WEBSOCKET_SSL_HPP
|
|
|
|
#include <beast/websocket/teardown.hpp>
|
|
#include <boost/asio/ip/tcp.hpp>
|
|
#include <boost/asio/ssl/stream.hpp>
|
|
#include <memory>
|
|
|
|
namespace beast {
|
|
namespace websocket {
|
|
|
|
/** Tear down a `boost::asio::ssl::stream`.
|
|
|
|
This tears down a connection. The implementation will call
|
|
the overload of this function based on the `Stream` parameter
|
|
used to consruct the socket. When `Stream` is a user defined
|
|
type, and not a `boost::asio::ip::tcp::socket` or any
|
|
`boost::asio::ssl::stream`, callers are responsible for
|
|
providing a suitable overload of this function.
|
|
|
|
@param stream The stream to tear down.
|
|
|
|
@param ec Set to the error if any occurred.
|
|
*/
|
|
template<class SyncStream>
|
|
void
|
|
teardown(teardown_tag,
|
|
boost::asio::ssl::stream<SyncStream>& stream,
|
|
error_code& ec);
|
|
|
|
/** Start tearing down a `boost::asio::ssl::stream`.
|
|
|
|
This begins tearing down a connection asynchronously.
|
|
The implementation will call the overload of this function
|
|
based on the `Stream` parameter used to consruct the socket.
|
|
When `Stream` is a user defined type, and not a
|
|
`boost::asio::ip::tcp::socket` or any `boost::asio::ssl::stream`,
|
|
callers are responsible for providing a suitable overload
|
|
of this function.
|
|
|
|
@param stream The stream to tear down.
|
|
|
|
@param handler The handler to be called when the request completes.
|
|
Copies will be made of the handler as required. The equivalent
|
|
function signature of the handler must be:
|
|
@code void handler(
|
|
error_code const& error // result of operation
|
|
); @endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using boost::asio::io_service::post().
|
|
|
|
*/
|
|
template<class AsyncStream, class TeardownHandler>
|
|
inline
|
|
void
|
|
async_teardown(teardown_tag,
|
|
boost::asio::ssl::stream<AsyncStream>& stream,
|
|
TeardownHandler&& handler);
|
|
|
|
} // websocket
|
|
} // beast
|
|
|
|
#include <beast/websocket/impl/ssl.ipp>
|
|
|
|
#endif
|