ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor MultiSocket:

Browse Source 
* Variadic constructor argument list
* Tidy up sources and filenames
This commit is contained in:
Vinnie Falco
2014-04-21 12:52:50 -07:00
parent 560071bb68
commit 1e06ddf13c
6 changed files with 312 additions and 285 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Builds/VisualStudio2013/RippleD.vcxproj
View File

@@ -1824,7 +1824,7 @@
<ClCompile Include="..\..\src\ripple\common\impl\MultiSocket.cpp"> <ClCompile Include="..\..\src\ripple\common\impl\MultiSocket.cpp">
<ExcludedFromBuild>True</ExcludedFromBuild> <ExcludedFromBuild>True</ExcludedFromBuild>
</ClCompile> </ClCompile>
<ClInclude Include="..\..\src\ripple\common\impl\MultiSocketType.h"> <ClInclude Include="..\..\src\ripple\common\impl\MultiSocketImpl.h">
</ClInclude> </ClInclude>
<ClCompile Include="..\..\src\ripple\common\impl\ResolverAsio.cpp"> <ClCompile Include="..\..\src\ripple\common\impl\ResolverAsio.cpp">
<ExcludedFromBuild>True</ExcludedFromBuild> <ExcludedFromBuild>True</ExcludedFromBuild>

2
Builds/VisualStudio2013/RippleD.vcxproj.filters
View File

@@ -2793,7 +2793,7 @@
<ClCompile Include="..\..\src\ripple\common\impl\MultiSocket.cpp"> <ClCompile Include="..\..\src\ripple\common\impl\MultiSocket.cpp">
<Filter>src\ripple\common\impl</Filter> <Filter>src\ripple\common\impl</Filter>
</ClCompile> </ClCompile>
<ClInclude Include="..\..\src\ripple\common\impl\MultiSocketType.h"> <ClInclude Include="..\..\src\ripple\common\impl\MultiSocketImpl.h">
<Filter>src\ripple\common\impl</Filter> <Filter>src\ripple\common\impl</Filter>
</ClInclude> </ClInclude>
<ClCompile Include="..\..\src\ripple\common\impl\ResolverAsio.cpp"> <ClCompile Include="..\..\src\ripple\common\impl\ResolverAsio.cpp">

281
src/ripple/common/impl/MultiSocket.cpp
View File

@@ -17,13 +17,12 @@
*/ */
//============================================================================== //==============================================================================
#include <ripple/common/impl/MultiSocketType.h> //#include <ripple/common/impl/MultiSocketType.h>
//#include <ripple/common/RippleSSLContext.h>
//#include <beast/unit_test/suite.h>
//#include <cassert>
#include <ripple/common/RippleSSLContext.h> #include <ripple/common/impl/MultiSocketImpl.h>
#include <beast/unit_test/suite.h>
#include <cassert>
namespace ripple { namespace ripple {
@@ -32,8 +31,8 @@ MultiSocket* MultiSocket::New (
boost::asio::ssl::context& ssl_context, boost::asio::ssl::context& ssl_context,
int flags) int flags)
{ {
return new MultiSocketType <boost::asio::ip::tcp::socket&> ( return new MultiSocketImpl <boost::asio::ip::tcp::socket&> (
socket, ssl_context, flags); ssl_context, flags, socket);
} }
//------------------------------------------------------------------------------ //------------------------------------------------------------------------------
@@ -43,270 +42,8 @@ MultiSocket* MultiSocket::New (
boost::asio::ssl::context& ssl_context, boost::asio::ssl::context& ssl_context,
int flags) int flags)
{ {
return new MultiSocketType <boost::asio::ip::tcp::socket> ( return new MultiSocketImpl <boost::asio::ip::tcp::socket> (
io_service, ssl_context, flags); ssl_context, flags, io_service);
} }
//------------------------------------------------------------------------------
class MultiSocket_test : public beast::unit_test::suite
{
public:
class MultiSocketDetails : public beast::asio::TestPeerDetails
{
public:
typedef int arg_type;
MultiSocketDetails (int flags)
: m_flags (flags)
{
}
static beast::String getArgName (arg_type arg)
{
beast::String s;
if (arg & MultiSocket::Flag::client_role)
s << "client,";
if (arg & MultiSocket::Flag::server_role)
s << "server,";
if (arg & MultiSocket::Flag::ssl)
s << "ssl,";
if (arg & MultiSocket::Flag::ssl_required)
s << "ssl_required,";
if (arg & MultiSocket::Flag::proxy)
s << "proxy,";
if (s != beast::String::empty)
{
s = "(" + s.substring (0, s.length () - 1) + ")";
}
return s;
}
static boost::asio::ssl::context& getSSLContext ()
{
struct ContextHolder
{
ContextHolder ()
: context (RippleSSLContext::createAnonymous (
"ALL:!LOW:!EXP:!MD5:@STRENGTH"))
{
// VFALCO NOTE Not sure if this is needed?
context->get().set_verify_mode (
boost::asio::ssl::verify_none);
}
std::unique_ptr <RippleSSLContext> context;
};
static ContextHolder holder;
return holder.context->get ();
}
beast::String name () const
{
return getArgName (m_flags);
}
arg_type getFlags () const noexcept
{
return m_flags;
}
protected:
arg_type m_flags;
};
//--------------------------------------------------------------------------
template <class Protocol>
class MultiSocketDetailsType : public MultiSocketDetails
{
protected:
typedef Protocol protocol_type;
typedef typename protocol_type::socket socket_type;
typedef typename protocol_type::acceptor acceptor_type;
typedef typename protocol_type::endpoint endpoint_type;
typedef typename protocol_type::resolver resolver_type;
public:
typedef socket_type native_socket_type;
typedef acceptor_type native_acceptor_type;
MultiSocketDetailsType (arg_type flags)
: MultiSocketDetails (flags)
, m_socket (get_io_service ())
, m_acceptor (get_io_service ())
, m_multiSocket (m_socket, MultiSocketDetails::getSSLContext (), flags)
, m_acceptor_wrapper (m_acceptor)
{
}
beast::asio::abstract_socket&
get_socket ()
{
return m_multiSocket;
}
beast::asio::abstract_socket&
get_acceptor ()
{
return m_acceptor_wrapper;
}
socket_type&
get_native_socket ()
{
return m_socket;
}
acceptor_type&
get_native_acceptor ()
{
return m_acceptor;
}
endpoint_type
get_endpoint (beast::asio::PeerRole role)
{
if (role == beast::asio::PeerRole::server)
return endpoint_type (boost::asio::ip::tcp::v6 (), 1052);
else
return endpoint_type (boost::asio::ip::address_v6 ().from_string ("::1"), 1052);
}
protected:
socket_type m_socket;
acceptor_type m_acceptor;
MultiSocketType <socket_type&> m_multiSocket;
beast::asio::socket_wrapper <acceptor_type&> m_acceptor_wrapper;
};
//--------------------------------------------------------------------------
template <typename Protocol, typename ClientArg, typename ServerArg>
void runProxy (ClientArg const& clientArg, ServerArg const& serverArg)
{
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicProxyClient,
beast::asio::TestPeerLogicSyncServer> (
clientArg, serverArg, timeoutSeconds).report (*this);
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicProxyClient,
beast::asio::TestPeerLogicAsyncServer> (
clientArg, serverArg, timeoutSeconds).report (*this);
}
//--------------------------------------------------------------------------
template <typename Protocol, typename ClientArg, typename ServerArg>
void run (ClientArg const& clientArg, ServerArg const& serverArg)
{
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicSyncClient,
beast::asio::TestPeerLogicSyncServer>
(clientArg, serverArg, timeoutSeconds).report (*this);
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicAsyncClient,
beast::asio::TestPeerLogicSyncServer>
(clientArg, serverArg, timeoutSeconds).report (*this);
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicSyncClient,
beast::asio::TestPeerLogicAsyncServer>
(clientArg, serverArg, timeoutSeconds).report (*this);
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicAsyncClient,
beast::asio::TestPeerLogicAsyncServer>
(clientArg, serverArg, timeoutSeconds).report (*this);
}
//--------------------------------------------------------------------------
template <typename Protocol>
void testProxyFlags (int extraClientFlags, int extraServerFlags)
{
assert (! MultiSocket::Flag (extraClientFlags).any_set (
MultiSocket::Flag::client_role | MultiSocket::Flag::server_role));
runProxy <Protocol> (MultiSocket::Flag::client_role | extraClientFlags,
MultiSocket::Flag::server_role | extraServerFlags);
}
//--------------------------------------------------------------------------
template <typename Protocol>
void testFlags (int extraClientFlags, int extraServerFlags)
{
assert (! MultiSocket::Flag (extraClientFlags).any_set (
MultiSocket::Flag::client_role | MultiSocket::Flag::server_role));
run <Protocol> (MultiSocket::Flag::client_role | extraClientFlags,
MultiSocket::Flag::server_role | extraServerFlags);
}
template <typename Protocol>
void testProtocol ()
{
// Simple tests
run <Protocol> (0,
0);
run <Protocol> (MultiSocket::Flag::client_role,
0);
run <Protocol> (0, MultiSocket::Flag::server_role);
run <Protocol> (MultiSocket::Flag::client_role,
MultiSocket::Flag::server_role);
testFlags <Protocol> (MultiSocket::Flag::ssl,
MultiSocket::Flag::ssl_required);
// SSL-Detect tests
testFlags <Protocol> (0,
MultiSocket::Flag::ssl);
testFlags <Protocol> (MultiSocket::Flag::ssl,
MultiSocket::Flag::ssl);
// PROXY Handshake tests
testProxyFlags <Protocol> (MultiSocket::Flag::proxy,
MultiSocket::Flag::proxy);
testProxyFlags <Protocol> (MultiSocket::Flag::proxy | MultiSocket::Flag::ssl,
MultiSocket::Flag::proxy | MultiSocket::Flag::ssl_required);
// PROXY + SSL-Detect tests
testProxyFlags <Protocol> (MultiSocket::Flag::proxy,
MultiSocket::Flag::proxy | MultiSocket::Flag::ssl);
testProxyFlags <Protocol> (MultiSocket::Flag::proxy | MultiSocket::Flag::ssl,
MultiSocket::Flag::proxy | MultiSocket::Flag::ssl);
}
void run ()
{
testProtocol <boost::asio::ip::tcp> ();
}
//--------------------------------------------------------------------------
enum
{
timeoutSeconds = 10
};
};
BEAST_DEFINE_TESTSUITE(MultiSocket,common,ripple);
} }

20
src/ripple/common/impl/MultiSocketType.h → src/ripple/common/impl/MultiSocketImpl.h
View File

@@ -17,8 +17,8 @@
*/ */
//============================================================================== //==============================================================================
#ifndef RIPPLE_COMMON_MULTISOCKETTYPE_H_INCLUDED #ifndef RIPPLE_COMMON_MULTISOCKETIMPL_H_INCLUDED
#define RIPPLE_COMMON_MULTISOCKETTYPE_H_INCLUDED #define RIPPLE_COMMON_MULTISOCKETIMPL_H_INCLUDED
#include <ripple/common/MultiSocket.h> #include <ripple/common/MultiSocket.h>
@@ -38,7 +38,7 @@ namespace ripple {
/** Template for producing instances of MultiSocket */ /** Template for producing instances of MultiSocket */
template <class StreamSocket> template <class StreamSocket>
class MultiSocketType class MultiSocketImpl
: public MultiSocket : public MultiSocket
{ {
private: private:
@@ -77,16 +77,16 @@ public:
typedef std::remove_reference_t <StreamSocket> next_layer_type; typedef std::remove_reference_t <StreamSocket> next_layer_type;
typedef typename next_layer_type::lowest_layer_type lowest_layer_type; typedef typename next_layer_type::lowest_layer_type lowest_layer_type;
template <typename Arg> template <class... Args>
MultiSocketType (Arg& arg, MultiSocketImpl (boost::asio::ssl::context& ssl_context, int flags,
boost::asio::ssl::context& ssl_context, int flags) Args&&... args)
: m_flags (flags) : m_flags (flags)
, m_state (stateNone) , m_state (stateNone)
, m_ssl_context (ssl_context) , m_ssl_context (ssl_context)
, m_verify_mode (0) , m_verify_mode (0)
, m_stream (nullptr) , m_stream (nullptr)
, m_needsShutdown (false) , m_needsShutdown (false)
, m_next_layer (arg) , m_next_layer (std::forward <Args> (args)...)
, m_proxyInfoSet (false) , m_proxyInfoSet (false)
, m_native_ssl_handle (nullptr) , m_native_ssl_handle (nullptr)
, m_origFlags (cleaned_flags (flags)) , m_origFlags (cleaned_flags (flags))
@@ -162,7 +162,7 @@ protected:
//-------------------------------------------------------------------------- //--------------------------------------------------------------------------
// //
// MultiSocketType // MultiSocketImpl
// //
//-------------------------------------------------------------------------- //--------------------------------------------------------------------------
@@ -865,7 +865,7 @@ protected:
#endif #endif
error_handler m_handler; error_handler m_handler;
MultiSocketType <StreamSocket>& m_owner; MultiSocketImpl <StreamSocket>& m_owner;
Stream& m_stream; Stream& m_stream;
handshake_type const m_type; handshake_type const m_type;
boost::asio::basic_streambuf <Allocator> m_buffer; boost::asio::basic_streambuf <Allocator> m_buffer;
@@ -875,7 +875,7 @@ protected:
beast::asio::HandshakeDetectLogicSSL3> m_ssl; beast::asio::HandshakeDetectLogicSSL3> m_ssl;
bool m_first_time; bool m_first_time;
AsyncOp (MultiSocketType <StreamSocket>& owner, Stream& stream, AsyncOp (MultiSocketImpl <StreamSocket>& owner, Stream& stream,
handshake_type type, beast::asio::const_buffers const& buffers, handshake_type type, beast::asio::const_buffers const& buffers,
error_handler const& handler) error_handler const& handler)
: m_handler (handler) : m_handler (handler)

291
src/ripple/common/tests/MultiSocket.test.cpp Normal file
View File

@@ -0,0 +1,291 @@
//------------------------------------------------------------------------------
/*
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.
*/
//==============================================================================
#include "../impl/MultiSocketImpl.h"
#include "../RippleSSLContext.h"
#include "../../beast/beast/unit_test/suite.h"
#include <cassert>
namespace ripple {
class MultiSocket_test : public beast::unit_test::suite
{
public:
class MultiSocketDetails : public beast::asio::TestPeerDetails
{
public:
typedef int arg_type;
MultiSocketDetails (int flags)
: m_flags (flags)
{
}
static beast::String getArgName (arg_type arg)
{
beast::String s;
if (arg & MultiSocket::Flag::client_role)
s << "client,";
if (arg & MultiSocket::Flag::server_role)
s << "server,";
if (arg & MultiSocket::Flag::ssl)
s << "ssl,";
if (arg & MultiSocket::Flag::ssl_required)
s << "ssl_required,";
if (arg & MultiSocket::Flag::proxy)
s << "proxy,";
if (s != beast::String::empty)
{
s = "(" + s.substring (0, s.length () - 1) + ")";
}
return s;
}
static boost::asio::ssl::context& getSSLContext ()
{
struct ContextHolder
{
ContextHolder ()
: context (RippleSSLContext::createAnonymous (
"ALL:!LOW:!EXP:!MD5:@STRENGTH"))
{
// VFALCO NOTE Not sure if this is needed?
context->get().set_verify_mode (
boost::asio::ssl::verify_none);
}
std::unique_ptr <RippleSSLContext> context;
};
static ContextHolder holder;
return holder.context->get ();
}
beast::String name () const
{
return getArgName (m_flags);
}
arg_type getFlags () const noexcept
{
return m_flags;
}
protected:
arg_type m_flags;
};
//--------------------------------------------------------------------------
template <class Protocol>
class MultiSocketDetailsType : public MultiSocketDetails
{
protected:
typedef Protocol protocol_type;
typedef typename protocol_type::socket socket_type;
typedef typename protocol_type::acceptor acceptor_type;
typedef typename protocol_type::endpoint endpoint_type;
typedef typename protocol_type::resolver resolver_type;
public:
typedef socket_type native_socket_type;
typedef acceptor_type native_acceptor_type;
MultiSocketDetailsType (arg_type flags)
: MultiSocketDetails (flags)
, m_socket (get_io_service ())
, m_acceptor (get_io_service ())
, m_multiSocket (MultiSocketDetails::getSSLContext (),
flags, m_socket)
, m_acceptor_wrapper (m_acceptor)
{
}
beast::asio::abstract_socket&
get_socket ()
{
return m_multiSocket;
}
beast::asio::abstract_socket&
get_acceptor ()
{
return m_acceptor_wrapper;
}
socket_type&
get_native_socket ()
{
return m_socket;
}
acceptor_type&
get_native_acceptor ()
{
return m_acceptor;
}
endpoint_type
get_endpoint (beast::asio::PeerRole role)
{
if (role == beast::asio::PeerRole::server)
return endpoint_type (boost::asio::ip::tcp::v6 (), 1052);
else
return endpoint_type (boost::asio::ip::address_v6 ().from_string ("::1"), 1052);
}
protected:
socket_type m_socket;
acceptor_type m_acceptor;
MultiSocketImpl <socket_type&> m_multiSocket;
beast::asio::socket_wrapper <acceptor_type&> m_acceptor_wrapper;
};
//--------------------------------------------------------------------------
template <typename Protocol, typename ClientArg, typename ServerArg>
void runProxy (ClientArg const& clientArg, ServerArg const& serverArg)
{
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicProxyClient,
beast::asio::TestPeerLogicSyncServer> (
clientArg, serverArg, timeoutSeconds).report (*this);
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicProxyClient,
beast::asio::TestPeerLogicAsyncServer> (
clientArg, serverArg, timeoutSeconds).report (*this);
}
//--------------------------------------------------------------------------
template <typename Protocol, typename ClientArg, typename ServerArg>
void run (ClientArg const& clientArg, ServerArg const& serverArg)
{
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicSyncClient,
beast::asio::TestPeerLogicSyncServer>
(clientArg, serverArg, timeoutSeconds).report (*this);
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicAsyncClient,
beast::asio::TestPeerLogicSyncServer>
(clientArg, serverArg, timeoutSeconds).report (*this);
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicSyncClient,
beast::asio::TestPeerLogicAsyncServer>
(clientArg, serverArg, timeoutSeconds).report (*this);
beast::asio::PeerTest::run <MultiSocketDetailsType <Protocol>,
beast::asio::TestPeerLogicAsyncClient,
beast::asio::TestPeerLogicAsyncServer>
(clientArg, serverArg, timeoutSeconds).report (*this);
}
//--------------------------------------------------------------------------
template <typename Protocol>
void testProxyFlags (int extraClientFlags, int extraServerFlags)
{
assert (! MultiSocket::Flag (extraClientFlags).any_set (
MultiSocket::Flag::client_role | MultiSocket::Flag::server_role));
runProxy <Protocol> (MultiSocket::Flag::client_role | extraClientFlags,
MultiSocket::Flag::server_role | extraServerFlags);
}
//--------------------------------------------------------------------------
template <typename Protocol>
void testFlags (int extraClientFlags, int extraServerFlags)
{
assert (! MultiSocket::Flag (extraClientFlags).any_set (
MultiSocket::Flag::client_role | MultiSocket::Flag::server_role));
run <Protocol> (MultiSocket::Flag::client_role | extraClientFlags,
MultiSocket::Flag::server_role | extraServerFlags);
}
template <typename Protocol>
void testProtocol ()
{
// Simple tests
run <Protocol> (0,
0);
run <Protocol> (MultiSocket::Flag::client_role,
0);
run <Protocol> (0, MultiSocket::Flag::server_role);
run <Protocol> (MultiSocket::Flag::client_role,
MultiSocket::Flag::server_role);
testFlags <Protocol> (MultiSocket::Flag::ssl,
MultiSocket::Flag::ssl_required);
// SSL-Detect tests
testFlags <Protocol> (0,
MultiSocket::Flag::ssl);
testFlags <Protocol> (MultiSocket::Flag::ssl,
MultiSocket::Flag::ssl);
// PROXY Handshake tests
testProxyFlags <Protocol> (MultiSocket::Flag::proxy,
MultiSocket::Flag::proxy);
testProxyFlags <Protocol> (MultiSocket::Flag::proxy | MultiSocket::Flag::ssl,
MultiSocket::Flag::proxy | MultiSocket::Flag::ssl_required);
// PROXY + SSL-Detect tests
testProxyFlags <Protocol> (MultiSocket::Flag::proxy,
MultiSocket::Flag::proxy | MultiSocket::Flag::ssl);
testProxyFlags <Protocol> (MultiSocket::Flag::proxy | MultiSocket::Flag::ssl,
MultiSocket::Flag::proxy | MultiSocket::Flag::ssl);
}
void run ()
{
testProtocol <boost::asio::ip::tcp> ();
}
//--------------------------------------------------------------------------
enum
{
timeoutSeconds = 10
};
};
BEAST_DEFINE_TESTSUITE(MultiSocket,common,ripple);
}

1
src/ripple/radmap/impl/BasicFullBelowCache.cpp
View File

@@ -17,7 +17,6 @@
*/ */
//============================================================================== //==============================================================================
namespace ripple { namespace ripple {
namespace RadMap { namespace RadMap {