mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 02:55:50 +00:00
54f6f0ceba
Beast.WebSocket provides developers with a robust WebSocket implementation built on Boost.Asio with a consistent asynchronous model using a modern C++ approach.
87 lines
3.1 KiB
C++
87 lines
3.1 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of Beast: https://github.com/vinniefalco/Beast
|
|
Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef BEAST_WSPROTO_SSL_H_INCLUDED
|
|
#define BEAST_WSPROTO_SSL_H_INCLUDED
|
|
|
|
#include <beast/wsproto/teardown.h>
|
|
#include <boost/asio/ip/tcp.hpp>
|
|
#include <boost/asio/ssl/stream.hpp>
|
|
#include <memory>
|
|
|
|
namespace beast {
|
|
namespace wsproto {
|
|
|
|
/** 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 socket The stream to tear down.
|
|
|
|
@param ec Set to the error if any occurred.
|
|
*/
|
|
template<class AsyncStream>
|
|
void
|
|
teardown(
|
|
boost::asio::ssl::stream<AsyncStream>& 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(
|
|
boost::asio::ssl::stream<AsyncStream>& stream,
|
|
TeardownHandler&& handler);
|
|
|
|
} // wsproto
|
|
} // beast
|
|
|
|
#include <beast/wsproto/impl/ssl.ipp>
|
|
|
|
#endif
|