mirror of
https://github.com/Xahau/xahaud.git
synced 2025-12-06 17:27:52 +00:00
e2c67a1666
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.
187 lines
5.9 KiB
C++
187 lines
5.9 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_TEARDOWN_HPP
|
|
#define BEAST_WEBSOCKET_TEARDOWN_HPP
|
|
|
|
#include <beast/websocket/error.hpp>
|
|
#include <boost/asio/ip/tcp.hpp>
|
|
#include <type_traits>
|
|
|
|
namespace beast {
|
|
|
|
namespace websocket {
|
|
|
|
/** Tag type used to find teardown and async_teardown overloads
|
|
|
|
Overloads of @ref teardown and @async_teardown for user defined
|
|
types must take a value of type @ref teardown_tag in the first
|
|
argument in order to be found by the implementation.
|
|
*/
|
|
struct teardown_tag {};
|
|
|
|
/** Tear down a connection.
|
|
|
|
This tears down a connection. The implementation will call
|
|
the overload of this function based on the `Socket` parameter
|
|
used to consruct the socket. When `Socket` 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 socket The socket to tear down.
|
|
|
|
@param ec Set to the error if any occurred.
|
|
*/
|
|
template<class Socket>
|
|
void
|
|
teardown(teardown_tag, Socket& socket, error_code& ec)
|
|
{
|
|
/*
|
|
If you are trying to use OpenSSL and this goes off, you need to
|
|
add an include for <beast/websocket/ssl.hpp>.
|
|
|
|
If you are creating an instance of beast::websocket::stream with your
|
|
own user defined type, you must provide an overload of teardown with
|
|
the corresponding signature (including the teardown_tag).
|
|
*/
|
|
static_assert(sizeof(Socket)==-1,
|
|
"Unknown Socket type in teardown.");
|
|
};
|
|
|
|
/** Start tearing down a connection.
|
|
|
|
This begins tearing down a connection asynchronously.
|
|
The implementation will call the overload of this function
|
|
based on the `Socket` 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 socket The socket 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 Socket, class TeardownHandler>
|
|
void
|
|
async_teardown(teardown_tag, Socket& socket, TeardownHandler&& handler)
|
|
{
|
|
/*
|
|
If you are trying to use OpenSSL and this goes off, you need to
|
|
add an include for <beast/websocket/ssl.hpp>.
|
|
|
|
If you are creating an instance of beast::websocket::stream with your
|
|
own user defined type, you must provide an overload of teardown with
|
|
the corresponding signature (including the teardown_tag).
|
|
*/
|
|
static_assert(sizeof(Socket)==-1,
|
|
"Unknown Socket type in async_teardown.");
|
|
}
|
|
|
|
} // websocket
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
namespace websocket_helpers {
|
|
|
|
// Calls to teardown and async_teardown must be made from
|
|
// a namespace that does not contain any overloads of these
|
|
// functions. The websocket_helpers namespace is defined here
|
|
// for that purpose.
|
|
|
|
template<class Socket>
|
|
inline
|
|
void
|
|
call_teardown(Socket& socket, error_code& ec)
|
|
{
|
|
using websocket::teardown;
|
|
teardown(websocket::teardown_tag{}, socket, ec);
|
|
}
|
|
|
|
template<class Socket, class TeardownHandler>
|
|
inline
|
|
void
|
|
call_async_teardown(Socket& socket, TeardownHandler&& handler)
|
|
{
|
|
using websocket::async_teardown;
|
|
async_teardown(websocket::teardown_tag{}, socket,
|
|
std::forward<TeardownHandler>(handler));
|
|
}
|
|
|
|
} // websocket_helpers
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
namespace websocket {
|
|
|
|
/** Tear down a `boost::asio::ip::tcp::socket`.
|
|
|
|
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 socket The socket to tear down.
|
|
|
|
@param ec Set to the error if any occurred.
|
|
*/
|
|
void
|
|
teardown(teardown_tag,
|
|
boost::asio::ip::tcp::socket& socket, error_code& ec);
|
|
|
|
/** Start tearing down a `boost::asio::ip::tcp::socket`.
|
|
|
|
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 socket The socket 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 TeardownHandler>
|
|
void
|
|
async_teardown(teardown_tag,
|
|
boost::asio::ip::tcp::socket& socket, TeardownHandler&& handler);
|
|
|
|
} // websocket
|
|
|
|
} // beast
|
|
|
|
#include <beast/websocket/impl/teardown.ipp>
|
|
|
|
#endif
|