mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
* New tools for completion handlers: - wrap_handler provides composed io_service execution guarantees. - bind_handler rebinds arguments to handlers. - shared_handler type-erases any completion handler. - buffer_sequence type-erases templated BufferSequences - abstract_socket replaces Socket - socket_wrapper replaces SocketWrapper - beast::asio placeholders to work with std::bind * Removed obsolete classes and functions - AbstractHandler - ComposedAsyncOperation - SharedFunction - SharedHandler - SharedHandlerAllocator - SharedHandlerPtr - SharedHandlerType - SocketBase - SocketWrapperStrand - wrapHandler * Refactored classes to use new tools - abstract_socket - socket_wrapper - HandshakeDetector - HttpClientType * Miscellanous tidying - socket classes moved to beast::asio namespace - beast asio files provide their own namespace declaration. - Fix IsCallPossible conflicting template parameter name - Use <boost/get_pointer.hpp> for C++11 compatibility. - Remove extraneous include path from build environment.
133 lines
3.8 KiB
C++
133 lines
3.8 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2012, 2013 Ripple Labs Inc.
|
|
|
|
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 RIPPLE_COMMON_MULTISOCKET_H_INCLUDED
|
|
#define RIPPLE_COMMON_MULTISOCKET_H_INCLUDED
|
|
|
|
#include "../beast/modules/beast_asio/beast_asio.h"
|
|
|
|
namespace ripple {
|
|
|
|
/** An abstract_socket that can handshake with multiple protocols. */
|
|
class MultiSocket
|
|
: public beast::asio::abstract_socket
|
|
{
|
|
public:
|
|
// immutable flags
|
|
struct Flag
|
|
{
|
|
enum Bit
|
|
{
|
|
peer = 0, // no handshaking. remaining flags ignored.
|
|
client_role = 1, // operate in client role
|
|
server_role = 2, // operate in server role
|
|
|
|
proxy = 4, // client: will send PROXY handshake
|
|
// server: PROXY handshake required
|
|
|
|
ssl = 8, // client: will use ssl
|
|
// server: will allow, but not require ssl
|
|
|
|
ssl_required = 16 // client: ignored
|
|
// server: will require ssl (ignores ssl flag)
|
|
};
|
|
|
|
Flag (int flags = 0) noexcept
|
|
: m_flags (flags)
|
|
{
|
|
}
|
|
|
|
Flag& operator= (int mask) noexcept
|
|
{
|
|
m_flags = mask;
|
|
return *this;
|
|
}
|
|
|
|
bool operator== (Flag const& other) const noexcept
|
|
{
|
|
return m_flags == other.m_flags;
|
|
}
|
|
|
|
inline bool set (int mask) const noexcept
|
|
{
|
|
return (m_flags & mask) == mask;
|
|
}
|
|
|
|
inline bool any_set (int mask) const noexcept
|
|
{
|
|
return (m_flags & mask) != 0;
|
|
}
|
|
|
|
Flag with (int mask) const noexcept
|
|
{
|
|
return Flag (m_flags | mask);
|
|
}
|
|
|
|
Flag without (int mask) const noexcept
|
|
{
|
|
return Flag (m_flags & ~mask);
|
|
}
|
|
|
|
int asBits () const noexcept
|
|
{
|
|
return m_flags;
|
|
}
|
|
|
|
private:
|
|
int m_flags;
|
|
};
|
|
|
|
enum Flags
|
|
{
|
|
none = 0,
|
|
client_ssl = 1,
|
|
server_ssl = 2,
|
|
server_ssl_required = 4,
|
|
server_proxy = 8
|
|
};
|
|
|
|
typedef beast::asio::HandshakeDetectLogicPROXY::ProxyInfo ProxyInfo;
|
|
|
|
// Note that this returns the original flags
|
|
virtual Flag getFlags () = 0;
|
|
|
|
virtual beast::IP::Endpoint local_endpoint() = 0;
|
|
virtual beast::IP::Endpoint remote_endpoint() = 0;
|
|
virtual ProxyInfo getProxyInfo () = 0;
|
|
|
|
/** Returns a pointer to the SSL handle or nullptr if no SSL. */
|
|
virtual SSL* ssl_handle () = 0;
|
|
|
|
// Caller owns the socket
|
|
static MultiSocket* New (
|
|
boost::asio::ip::tcp::socket& socket,
|
|
boost::asio::ssl::context& ssl_context,
|
|
int flags = 0);
|
|
|
|
// Caller owns the io_service
|
|
static MultiSocket* New (
|
|
boost::asio::io_service& io_service,
|
|
boost::asio::ssl::context& ssl_context,
|
|
int flags = 0);
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|