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

Public Types

using u256_acq_pair = std::pair< uint256, std::shared_ptr< InboundLedger > >
 
using clock_type = beast::abstract_clock< std::chrono::steady_clock >
 

Public Member Functions

 InboundLedgersImp (Application &app, clock_type &clock, Stoppable &parent, beast::insight::Collector::ptr const &collector)
 
std::shared_ptr< Ledger const > acquire (uint256 const &hash, std::uint32_t seq, InboundLedger::Reason reason) override
 
std::shared_ptr< InboundLedger > find (uint256 const &hash) override
 
bool gotLedgerData (LedgerHash const &hash, std::shared_ptr< Peer > peer, std::shared_ptr< protocol::TMLedgerData > packet_ptr) override
 We received a TMLedgerData from a peer. More...
 
void logFailure (uint256 const &h, std::uint32_t seq) override
 
bool isFailure (uint256 const &h) override
 
void doLedgerData (LedgerHash hash)
 Called (indirectly) only by gotLedgerData(). More...
 
void gotStaleData (std::shared_ptr< protocol::TMLedgerData > packet_ptr) override
 We got some data for a ledger we are no longer acquiring Since we paid the price to receive it, we might as well stash it in case we need it. More...
 
void clearFailures () override
 
std::size_t fetchRate () override
 Returns the rate of historical ledger fetches per minute. More...
 
void onLedgerFetched () override
 Called when a complete ledger is obtained. More...
 
Json::Value getInfo () override
 
void gotFetchPack () override
 
void sweep () override
 
void onStop () override
 
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...
 

Static Public Attributes

static const std::chrono::minutes kReacquireInterval
 

Protected Member Functions

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

Private Types

using ScopedLockType = std::unique_lock< std::recursive_mutex >
 
using MapType = hash_map< uint256, std::shared_ptr< InboundLedger > >
 
using Children = beast::LockFreeStack< Child >
 

Private Member Functions

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_
 
std::mutex fetchRateMutex_
 
DecayWindow< 30, clock_type > fetchRate_
 
const beast::Journal j_
 
clock_type & m_clock
 
std::recursive_mutex mLock
 
MapType mLedgers
 
beast::aged_map< uint256, std::uint32_t > mRecentFailures
 
beast::insight::Counter mCounter
 
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 36 of file InboundLedgers.cpp.

Member Typedef Documentation

◆ u256_acq_pair

using ripple::InboundLedgersImp::u256_acq_pair = std::pair<uint256, std::shared_ptr<InboundLedger> >

Definition at line 46 of file InboundLedgers.cpp.

◆ ScopedLockType

using ripple::InboundLedgersImp::ScopedLockType = std::unique_lock<std::recursive_mutex>
private

Definition at line 410 of file InboundLedgers.cpp.

◆ MapType

using ripple::InboundLedgersImp::MapType = hash_map<uint256, std::shared_ptr<InboundLedger> >
private

Definition at line 413 of file InboundLedgers.cpp.

◆ clock_type

using ripple::InboundLedgers::clock_type = beast::abstract_clock<std::chrono::steady_clock>
inherited

Definition at line 37 of file InboundLedgers.h.

◆ Children

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

Definition at line 318 of file Stoppable.h.

Constructor & Destructor Documentation

◆ InboundLedgersImp()

ripple::InboundLedgersImp::InboundLedgersImp ( Application &  app,
clock_type &  clock,
Stoppable &  parent,
beast::insight::Collector::ptr const &  collector 
)

Definition at line 51 of file InboundLedgers.cpp.

Member Function Documentation

◆ acquire()

std::shared_ptr<Ledger const> ripple::InboundLedgersImp::acquire ( uint256 const &  hash,
std::uint32_t  seq,
InboundLedger::Reason  reason 
)
overridevirtual

Implements ripple::InboundLedgers.

Definition at line 68 of file InboundLedgers.cpp.

Here is the call graph for this function:

◆ find()

std::shared_ptr<InboundLedger> ripple::InboundLedgersImp::find ( uint256 const &  hash)
overridevirtual

Implements ripple::InboundLedgers.

Definition at line 132 of file InboundLedgers.cpp.

◆ gotLedgerData()

bool ripple::InboundLedgersImp::gotLedgerData ( LedgerHash const &  hash,
std::shared_ptr< Peer >  peer,
std::shared_ptr< protocol::TMLedgerData >  packet_ptr 
)
overridevirtual

We received a TMLedgerData from a peer.

Implements ripple::InboundLedgers.

Definition at line 166 of file InboundLedgers.cpp.

◆ logFailure()

void ripple::InboundLedgersImp::logFailure ( uint256 const &  h,
std::uint32_t  seq 
)
overridevirtual

Implements ripple::InboundLedgers.

Definition at line 206 of file InboundLedgers.cpp.

◆ isFailure()

bool ripple::InboundLedgersImp::isFailure ( uint256 const &  h)
overridevirtual

Implements ripple::InboundLedgers.

Definition at line 214 of file InboundLedgers.cpp.

◆ doLedgerData()

void ripple::InboundLedgersImp::doLedgerData ( LedgerHash  hash)

Called (indirectly) only by gotLedgerData().

Definition at line 224 of file InboundLedgers.cpp.

◆ gotStaleData()

void ripple::InboundLedgersImp::gotStaleData ( std::shared_ptr< protocol::TMLedgerData >  packet_ptr)
overridevirtual

We got some data for a ledger we are no longer acquiring Since we paid the price to receive it, we might as well stash it in case we need it.

Nodes are received in wire format and must be stashed/hashed in prefix format

Implements ripple::InboundLedgers.

Definition at line 237 of file InboundLedgers.cpp.

◆ clearFailures()

void ripple::InboundLedgersImp::clearFailures ( )
overridevirtual

Implements ripple::InboundLedgers.

Definition at line 270 of file InboundLedgers.cpp.

◆ fetchRate()

std::size_t ripple::InboundLedgersImp::fetchRate ( )
overridevirtual

Returns the rate of historical ledger fetches per minute.

Implements ripple::InboundLedgers.

Definition at line 279 of file InboundLedgers.cpp.

◆ onLedgerFetched()

void ripple::InboundLedgersImp::onLedgerFetched ( )
overridevirtual

Called when a complete ledger is obtained.

Implements ripple::InboundLedgers.

Definition at line 288 of file InboundLedgers.cpp.

◆ getInfo()

Json::Value ripple::InboundLedgersImp::getInfo ( )
overridevirtual

Implements ripple::InboundLedgers.

Definition at line 295 of file InboundLedgers.cpp.

◆ gotFetchPack()

void ripple::InboundLedgersImp::gotFetchPack ( )
overridevirtual

Implements ripple::InboundLedgers.

Definition at line 333 of file InboundLedgers.cpp.

◆ sweep()

void ripple::InboundLedgersImp::sweep ( )
overridevirtual

Implements ripple::InboundLedgers.

Definition at line 354 of file InboundLedgers.cpp.

◆ onStop()

void ripple::InboundLedgersImp::onStop ( )
overridevirtual

Implements ripple::InboundLedgers.

Definition at line 397 of file InboundLedgers.cpp.

◆ getRoot()

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

Definition at line 213 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 436 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 454 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::test::Stoppable_test::Root, ripple::OverlayImpl, 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::test::Stoppable_test::Root, ripple::OverlayImpl, 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 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::test::Stoppable_test::Root, ripple::OverlayImpl, 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::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::InboundLedgersImp::app_
private

Definition at line 39 of file InboundLedgers.cpp.

◆ fetchRateMutex_

std::mutex ripple::InboundLedgersImp::fetchRateMutex_
private

Definition at line 40 of file InboundLedgers.cpp.

◆ fetchRate_

DecayWindow<30, clock_type> ripple::InboundLedgersImp::fetchRate_
private

Definition at line 42 of file InboundLedgers.cpp.

◆ j_

const beast::Journal ripple::InboundLedgersImp::j_
private

Definition at line 43 of file InboundLedgers.cpp.

◆ kReacquireInterval

const std::chrono::minutes ripple::InboundLedgersImp::kReacquireInterval
static

Definition at line 49 of file InboundLedgers.cpp.

◆ m_clock

clock_type& ripple::InboundLedgersImp::m_clock
private

Definition at line 408 of file InboundLedgers.cpp.

◆ mLock

std::recursive_mutex ripple::InboundLedgersImp::mLock
private

Definition at line 411 of file InboundLedgers.cpp.

◆ mLedgers

MapType ripple::InboundLedgersImp::mLedgers
private

Definition at line 414 of file InboundLedgers.cpp.

◆ mRecentFailures

beast::aged_map<uint256, std::uint32_t> ripple::InboundLedgersImp::mRecentFailures
private

Definition at line 416 of file InboundLedgers.cpp.

◆ mCounter

beast::insight::Counter ripple::InboundLedgersImp::mCounter
private

Definition at line 418 of file InboundLedgers.cpp.

◆ m_name

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

Definition at line 338 of file Stoppable.h.

◆ m_root

RootStoppable& ripple::Stoppable::m_root
privateinherited

Definition at line 339 of file Stoppable.h.

◆ m_child

Child ripple::Stoppable::m_child
privateinherited

Definition at line 340 of file Stoppable.h.

◆ m_stopped

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

Definition at line 341 of file Stoppable.h.

◆ m_childrenStopped

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

Definition at line 342 of file Stoppable.h.

◆ m_children

Children ripple::Stoppable::m_children
privateinherited

Definition at line 343 of file Stoppable.h.

◆ m_cv

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

Definition at line 344 of file Stoppable.h.

◆ m_mut

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

Definition at line 345 of file Stoppable.h.

◆ m_is_stopping

bool ripple::Stoppable::m_is_stopping = false
privateinherited

Definition at line 346 of file Stoppable.h.

◆ hasParent_

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

Definition at line 347 of file Stoppable.h.

Generated by   doxygen 1.8.17