rippled
Classes | Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ripple::ServerHandlerImp Class Reference
Inheritance diagram for ripple::ServerHandlerImp:
Inheritance graph
[legend]
Collaboration diagram for ripple::ServerHandlerImp:
Collaboration graph
[legend]

Classes

struct  Setup
 

Public Types

using Output = Json::Output
 

Public Member Functions

 ServerHandlerImp (Application &app, Stoppable &parent, boost::asio::io_service &io_service, JobQueue &jobQueue, NetworkOPs &networkOPs, Resource::Manager &resourceManager, CollectorManager &cm)
 
 ~ServerHandlerImp ()
 
void setup (Setup const &setup, beast::Journal journal)
 
Setup const & setup () const
 
void onStop () override
 Override called when the stop notification is issued. More...
 
bool onAccept (Session &session, boost::asio::ip::tcp::endpoint endpoint)
 
Handoff onHandoff (Session &session, std::unique_ptr< stream_type > &&bundle, http_request_type &&request, boost::asio::ip::tcp::endpoint const &remote_address)
 
Handoff onHandoff (Session &session, http_request_type &&request, boost::asio::ip::tcp::endpoint const &remote_address)
 
void onRequest (Session &session)
 
void onWSMessage (std::shared_ptr< WSSession > session, std::vector< boost::asio::const_buffer > const &buffers)
 
void onClose (Session &session, boost::system::error_code const &)
 
void onStopped (Server &)
 
RootStoppable & getRoot ()
 
void setParent (Stoppable &parent)
 Set the parent of this Stoppable. More...
 
bool isStopping () const
 Returns true if the stoppable should stop. More...
 
bool isStopped () const
 Returns true if the requested stop has completed. More...
 
bool areChildrenStopped () const
 Returns true if all children have stopped. More...
 
JobCounter & jobCounter ()
 
bool alertable_sleep_until (std::chrono::system_clock::time_point const &t)
 Sleep or wake up on stop. More...
 

Protected Member Functions

void stopped ()
 Called by derived classes to indicate that the stoppable has stopped. More...
 

Private Types

using socket_type = boost::beast::tcp_stream
 
using stream_type = boost::beast::ssl_stream< socket_type >
 
using Children = beast::LockFreeStack< Child >
 

Private Member Functions

Json::Value processSession (std::shared_ptr< WSSession > const &session, std::shared_ptr< JobQueue::Coro > const &coro, Json::Value const &jv)
 
void processSession (std::shared_ptr< Session > const &, std::shared_ptr< JobQueue::Coro > coro)
 
void processRequest (Port const &port, std::string const &request, beast::IP::Endpoint const &remoteIPAddress, Output &&, std::shared_ptr< JobQueue::Coro > coro, boost::string_view forwardedFor, boost::string_view user)
 
Handoff statusResponse (http_request_type const &request) const
 
virtual void onPrepare ()
 Override called during preparation. More...
 
virtual void onStart ()
 Override called during start. More...
 
virtual void onChildrenStopped ()
 Override called when all children have stopped. More...
 
void prepareRecursive ()
 
void startRecursive ()
 
void stopAsyncRecursive (beast::Journal j)
 
void stopRecursive (beast::Journal j)
 

Private Attributes

Application & app_
 
Resource::Manager & m_resourceManager
 
beast::Journal m_journal
 
NetworkOPs & m_networkOPs
 
std::unique_ptr< Server > m_server
 
Setup setup_
 
JobQueue & m_jobQueue
 
beast::insight::Counter rpc_requests_
 
beast::insight::Event rpc_size_
 
beast::insight::Event rpc_time_
 
std::mutex countlock_
 
std::map< std::reference_wrapper< Port const >, int > count_
 
std::string m_name
 
RootStoppable & m_root
 
Child m_child
 
std::atomic< bool > m_stopped {false}
 
std::atomic< bool > m_childrenStopped {false}
 
Children m_children
 
std::condition_variable m_cv
 
std::mutex m_mut
 
bool m_is_stopping = false
 
bool hasParent_ {false}
 

Detailed Description

Definition at line 46 of file ServerHandlerImp.h.

Member Typedef Documentation

◆ socket_type

using ripple::ServerHandlerImp::socket_type = boost::beast::tcp_stream
private

Definition at line 88 of file ServerHandlerImp.h.

◆ stream_type

using ripple::ServerHandlerImp::stream_type = boost::beast::ssl_stream<socket_type>
private

Definition at line 89 of file ServerHandlerImp.h.

◆ Output

using ripple::ServerHandlerImp::Output = Json::Output

Definition at line 116 of file ServerHandlerImp.h.

◆ Children

using ripple::Stoppable::Children = beast::LockFreeStack<Child>
privateinherited

Definition at line 319 of file Stoppable.h.

Constructor & Destructor Documentation

◆ ServerHandlerImp()

ripple::ServerHandlerImp::ServerHandlerImp ( Application &  app,
Stoppable &  parent,
boost::asio::io_service &  io_service,
JobQueue &  jobQueue,
NetworkOPs &  networkOPs,
Resource::Manager &  resourceManager,
CollectorManager &  cm 
)

Definition at line 104 of file ServerHandlerImp.cpp.

◆ ~ServerHandlerImp()

ripple::ServerHandlerImp::~ServerHandlerImp ( )

Definition at line 126 of file ServerHandlerImp.cpp.

Member Function Documentation

◆ setup() [1/2]

void ripple::ServerHandlerImp::setup ( Setup const &  setup,
beast::Journal  journal 
)

Definition at line 132 of file ServerHandlerImp.cpp.

◆ setup() [2/2]

Setup const& ripple::ServerHandlerImp::setup ( ) const

Definition at line 122 of file ServerHandlerImp.h.

◆ onStop()

void ripple::ServerHandlerImp::onStop ( )
overridevirtual

Override called when the stop notification is issued.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation simply calls stopped(). This is applicable when the Stoppable has a trivial stop operation (or no stop operation), and we are merely using the Stoppable API to position it as a dependency of some parent service.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Reimplemented from ripple::Stoppable.

Definition at line 141 of file ServerHandlerImp.cpp.

◆ onAccept()

bool ripple::ServerHandlerImp::onAccept ( Session &  session,
boost::asio::ip::tcp::endpoint  endpoint 
)

Definition at line 149 of file ServerHandlerImp.cpp.

◆ onHandoff() [1/2]

Handoff ripple::ServerHandlerImp::onHandoff ( Session &  session,
std::unique_ptr< stream_type > &&  bundle,
http_request_type &&  request,
boost::asio::ip::tcp::endpoint const &  remote_address 
)

Definition at line 168 of file ServerHandlerImp.cpp.

◆ onHandoff() [2/2]

Handoff ripple::ServerHandlerImp::onHandoff ( Session &  session,
http_request_type &&  request,
boost::asio::ip::tcp::endpoint const &  remote_address 
)

Definition at line 149 of file ServerHandlerImp.h.

◆ onRequest()

void ripple::ServerHandlerImp::onRequest ( Session &  session)

Definition at line 268 of file ServerHandlerImp.cpp.

◆ onWSMessage()

void ripple::ServerHandlerImp::onWSMessage ( std::shared_ptr< WSSession >  session,
std::vector< boost::asio::const_buffer > const &  buffers 
)

Definition at line 308 of file ServerHandlerImp.cpp.

◆ onClose()

void ripple::ServerHandlerImp::onClose ( Session &  session,
boost::system::error_code const &   
)

Definition at line 358 of file ServerHandlerImp.cpp.

◆ onStopped()

void ripple::ServerHandlerImp::onStopped ( Server &  )

Definition at line 365 of file ServerHandlerImp.cpp.

◆ processSession() [1/2]

Json::Value ripple::ServerHandlerImp::processSession ( std::shared_ptr< WSSession > const &  session,
std::shared_ptr< JobQueue::Coro > const &  coro,
Json::Value const &  jv 
)
private

Definition at line 373 of file ServerHandlerImp.cpp.

◆ processSession() [2/2]

void ripple::ServerHandlerImp::processSession ( std::shared_ptr< Session > const &  session,
std::shared_ptr< JobQueue::Coro >  coro 
)
private

Definition at line 512 of file ServerHandlerImp.cpp.

◆ processRequest()

void ripple::ServerHandlerImp::processRequest ( Port const &  port,
std::string const &  request,
beast::IP::Endpoint const &  remoteIPAddress,
Output &&  output,
std::shared_ptr< JobQueue::Coro >  coro,
boost::string_view  forwardedFor,
boost::string_view  user 
)
private

Clear header-assigned values if not positively identified from a secure_gateway.

Definition at line 553 of file ServerHandlerImp.cpp.

◆ statusResponse()

Handoff ripple::ServerHandlerImp::statusResponse ( http_request_type const &  request) const
private

Definition at line 933 of file ServerHandlerImp.cpp.

◆ getRoot()

RootStoppable& ripple::Stoppable::getRoot ( )
inherited

Definition at line 214 of file Stoppable.h.

◆ setParent()

void ripple::Stoppable::setParent ( Stoppable &  parent)
inherited

Set the parent of this Stoppable.

Note
The Stoppable must not already have a parent. The parent to be set cannot not be stopping. Both roots must match.

Definition at line 43 of file Stoppable.cpp.

◆ isStopping()

bool ripple::Stoppable::isStopping ( ) const
inherited

Returns true if the stoppable should stop.

Definition at line 54 of file Stoppable.cpp.

◆ isStopped()

bool ripple::Stoppable::isStopped ( ) const
inherited

Returns true if the requested stop has completed.

Definition at line 60 of file Stoppable.cpp.

◆ areChildrenStopped()

bool ripple::Stoppable::areChildrenStopped ( ) const
inherited

Returns true if all children have stopped.

Definition at line 66 of file Stoppable.cpp.

◆ jobCounter()

JobCounter & ripple::Stoppable::jobCounter ( )
inherited

Definition at line 437 of file Stoppable.h.

◆ alertable_sleep_until()

bool ripple::Stoppable::alertable_sleep_until ( std::chrono::system_clock::time_point const &  t)
inherited

Sleep or wake up on stop.

Returns
true if we are stopping

Definition at line 455 of file Stoppable.h.

◆ stopped()

void ripple::Stoppable::stopped ( )
protectedinherited

Called by derived classes to indicate that the stoppable has stopped.

Definition at line 72 of file Stoppable.cpp.

◆ onPrepare()

void ripple::Stoppable::onPrepare ( )
privatevirtualinherited

Override called during preparation.

Since all other Stoppable objects in the tree have already been constructed, this provides an opportunity to perform initialization which depends on calling into other Stoppable objects. This call is made on the same thread that called prepare(). The default implementation does nothing. Guaranteed to only be called once.

Reimplemented in ripple::ApplicationImp, ripple::OverlayImpl, ripple::test::Stoppable_test::Root, ripple::test::Stoppable_test::C, ripple::test::Stoppable_test::I, ripple::test::Stoppable_test::B, ripple::test::Stoppable_test::H, ripple::test::Stoppable_test::G, ripple::SHAMapStoreImp, ripple::test::Stoppable_test::A, ripple::PeerFinder::ManagerImp, ripple::perf::PerfLogImp, ripple::test::Stoppable_test::F, ripple::test::Stoppable_test::E, ripple::detail::LedgerCleanerImp, ripple::test::Stoppable_test::J, ripple::LoadManager, ripple::PerfLog_test::PerfLogParent, and ripple::test::Stoppable_test::D.

Definition at line 80 of file Stoppable.cpp.

◆ onStart()

void ripple::Stoppable::onStart ( )
privatevirtualinherited

Override called during start.

Reimplemented in ripple::ApplicationImp, ripple::OverlayImpl, ripple::test::Stoppable_test::Root, ripple::test::Stoppable_test::C, ripple::test::Stoppable_test::I, ripple::test::Stoppable_test::B, ripple::test::Stoppable_test::H, ripple::test::Stoppable_test::G, ripple::SHAMapStoreImp, ripple::GRPCServer, ripple::test::Stoppable_test::A, ripple::PeerFinder::ManagerImp, ripple::perf::PerfLogImp, ripple::test::Stoppable_test::F, ripple::test::Stoppable_test::E, ripple::detail::LedgerCleanerImp, ripple::test::Stoppable_test::J, ripple::LoadManager, ripple::PerfLog_test::PerfLogParent, and ripple::test::Stoppable_test::D.

Definition at line 85 of file Stoppable.cpp.

◆ onChildrenStopped()

void ripple::Stoppable::onChildrenStopped ( )
privatevirtualinherited

Override called when all children have stopped.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation does nothing.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Reimplemented in ripple::OverlayImpl, ripple::test::Stoppable_test::Root, ripple::test::Stoppable_test::C, ripple::test::Stoppable_test::I, ripple::test::Stoppable_test::B, ripple::JobQueue, ripple::test::Stoppable_test::H, ripple::test::Stoppable_test::G, ripple::SHAMapStoreImp, ripple::test::Stoppable_test::A, ripple::NodeStore::Database, ripple::perf::PerfLogImp, ripple::test::Stoppable_test::F, ripple::test::Stoppable_test::E, ripple::NodeStore::DatabaseShardImp, ripple::test::Stoppable_test::J, ripple::PerfLog_test::PerfLogParent, ripple::test::Stoppable_test::D, and ripple::NodeStoreScheduler.

Definition at line 96 of file Stoppable.cpp.

◆ prepareRecursive()

void ripple::Stoppable::prepareRecursive ( )
privateinherited

Definition at line 103 of file Stoppable.cpp.

◆ startRecursive()

void ripple::Stoppable::startRecursive ( )
privateinherited

Definition at line 113 of file Stoppable.cpp.

◆ stopAsyncRecursive()

void ripple::Stoppable::stopAsyncRecursive ( beast::Journal  j)
privateinherited

Definition at line 123 of file Stoppable.cpp.

◆ stopRecursive()

void ripple::Stoppable::stopRecursive ( beast::Journal  j)
privateinherited

Definition at line 134 of file Stoppable.cpp.

Member Data Documentation

◆ app_

Application& ripple::ServerHandlerImp::app_
private

Definition at line 91 of file ServerHandlerImp.h.

◆ m_resourceManager

Resource::Manager& ripple::ServerHandlerImp::m_resourceManager
private

Definition at line 92 of file ServerHandlerImp.h.

◆ m_journal

beast::Journal ripple::ServerHandlerImp::m_journal
private

Definition at line 93 of file ServerHandlerImp.h.

◆ m_networkOPs

NetworkOPs& ripple::ServerHandlerImp::m_networkOPs
private

Definition at line 94 of file ServerHandlerImp.h.

◆ m_server

std::unique_ptr<Server> ripple::ServerHandlerImp::m_server
private

Definition at line 95 of file ServerHandlerImp.h.

◆ setup_

Setup ripple::ServerHandlerImp::setup_
private

Definition at line 96 of file ServerHandlerImp.h.

◆ m_jobQueue

JobQueue& ripple::ServerHandlerImp::m_jobQueue
private

Definition at line 97 of file ServerHandlerImp.h.

◆ rpc_requests_

beast::insight::Counter ripple::ServerHandlerImp::rpc_requests_
private

Definition at line 98 of file ServerHandlerImp.h.

◆ rpc_size_

beast::insight::Event ripple::ServerHandlerImp::rpc_size_
private

Definition at line 99 of file ServerHandlerImp.h.

◆ rpc_time_

beast::insight::Event ripple::ServerHandlerImp::rpc_time_
private

Definition at line 100 of file ServerHandlerImp.h.

◆ countlock_

std::mutex ripple::ServerHandlerImp::countlock_
private

Definition at line 101 of file ServerHandlerImp.h.

◆ count_

std::map<std::reference_wrapper<Port const>, int> ripple::ServerHandlerImp::count_
private

Definition at line 102 of file ServerHandlerImp.h.

◆ m_name

std::string ripple::Stoppable::m_name
privateinherited

Definition at line 339 of file Stoppable.h.

◆ m_root

RootStoppable& ripple::Stoppable::m_root
privateinherited

Definition at line 340 of file Stoppable.h.

◆ m_child

Child ripple::Stoppable::m_child
privateinherited

Definition at line 341 of file Stoppable.h.

◆ m_stopped

std::atomic<bool> ripple::Stoppable::m_stopped {false}
privateinherited

Definition at line 342 of file Stoppable.h.

◆ m_childrenStopped

std::atomic<bool> ripple::Stoppable::m_childrenStopped {false}
privateinherited

Definition at line 343 of file Stoppable.h.

◆ m_children

Children ripple::Stoppable::m_children
privateinherited

Definition at line 344 of file Stoppable.h.

◆ m_cv

std::condition_variable ripple::Stoppable::m_cv
privateinherited

Definition at line 345 of file Stoppable.h.

◆ m_mut

std::mutex ripple::Stoppable::m_mut
privateinherited

Definition at line 346 of file Stoppable.h.

◆ m_is_stopping

bool ripple::Stoppable::m_is_stopping = false
privateinherited

Definition at line 347 of file Stoppable.h.

◆ hasParent_

bool ripple::Stoppable::hasParent_ {false}
privateinherited

Definition at line 348 of file Stoppable.h.

Generated by   doxygen 1.8.17