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

Public Types

using clock_type = beast::abstract_clock< std::chrono::steady_clock >
 

Public Member Functions

 InboundTransactionsImp (Application &app, clock_type &clock, Stoppable &parent, beast::insight::Collector::ptr const &collector, std::function< void(std::shared_ptr< SHAMap > const &, bool)> gotSet)
 
TransactionAcquire::pointer getAcquire (uint256 const &hash)
 
std::shared_ptr< SHAMap > getSet (uint256 const &hash, bool acquire) override
 Retrieves a transaction set by hash. More...
 
void gotData (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 giveSet (uint256 const &hash, std::shared_ptr< SHAMap > const &set, bool fromAcquire) override
 Gives set to the container. More...
 
Json::Value getInfo () override
 
void newRound (std::uint32_t seq) override
 Informs the container if a new consensus round. More...
 
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...
 

Public Attributes

Application & app_
 

Protected Member Functions

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

Private Types

using MapType = hash_map< uint256, InboundTransactionSet >
 
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

clock_type & m_clock
 
std::recursive_mutex mLock
 
MapType m_map
 
std::uint32_t m_seq
 
InboundTransactionSet & m_zeroSet
 
std::function< void(std::shared_ptr< SHAMap > const &, bool)> m_gotSet
 
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 60 of file InboundTransactions.cpp.

Member Typedef Documentation

◆ MapType

using ripple::InboundTransactionsImp::MapType = hash_map <uint256, InboundTransactionSet>
private

Definition at line 276 of file InboundTransactions.cpp.

◆ clock_type

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

Definition at line 39 of file InboundTransactions.h.

◆ Children

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

Definition at line 306 of file Stoppable.h.

Constructor & Destructor Documentation

◆ InboundTransactionsImp()

ripple::InboundTransactionsImp::InboundTransactionsImp ( Application &  app,
clock_type &  clock,
Stoppable &  parent,
beast::insight::Collector::ptr const &  collector,
std::function< void(std::shared_ptr< SHAMap > const &, bool)>  gotSet 
)

Definition at line 67 of file InboundTransactions.cpp.

Member Function Documentation

◆ getAcquire()

TransactionAcquire::pointer ripple::InboundTransactionsImp::getAcquire ( uint256 const &  hash)

Definition at line 87 of file InboundTransactions.cpp.

◆ getSet()

std::shared_ptr<SHAMap> ripple::InboundTransactionsImp::getSet ( uint256 const &  setHash,
bool  acquire 
)
overridevirtual

Retrieves a transaction set by hash.

Implements ripple::InboundTransactions.

Definition at line 100 of file InboundTransactions.cpp.

◆ gotData()

void ripple::InboundTransactionsImp::gotData ( 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::InboundTransactions.

Definition at line 142 of file InboundTransactions.cpp.

◆ giveSet()

void ripple::InboundTransactionsImp::giveSet ( uint256 const &  setHash,
std::shared_ptr< SHAMap > const &  set,
bool  acquired 
)
overridevirtual

Gives set to the container.

Implements ripple::InboundTransactions.

Definition at line 181 of file InboundTransactions.cpp.

◆ getInfo()

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

Implements ripple::InboundTransactions.

Definition at line 208 of file InboundTransactions.cpp.

◆ newRound()

void ripple::InboundTransactionsImp::newRound ( std::uint32_t  seq)
overridevirtual

Informs the container if a new consensus round.

Implements ripple::InboundTransactions.

Definition at line 236 of file InboundTransactions.cpp.

◆ onStop()

void ripple::InboundTransactionsImp::onStop ( )
overridevirtual

Implements ripple::InboundTransactions.

Definition at line 264 of file InboundTransactions.cpp.

◆ getRoot()

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

Definition at line 212 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 46 of file Stoppable.cpp.

◆ isStopping()

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

Returns true if the stoppable should stop.

Definition at line 56 of file Stoppable.cpp.

◆ isStopped()

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

Returns true if the requested stop has completed.

Definition at line 61 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 413 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 433 of file Stoppable.h.

◆ stopped()

void ripple::Stoppable::stopped ( )
protectedinherited

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

Definition at line 71 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::PeerFinder::ManagerImp, ripple::perf::PerfLogImp, ripple::test::Stoppable_test::A, 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 78 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::PeerFinder::ManagerImp, ripple::perf::PerfLogImp, ripple::test::Stoppable_test::A, 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 82 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::JobQueue, ripple::test::Stoppable_test::B, 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 91 of file Stoppable.cpp.

◆ prepareRecursive()

void ripple::Stoppable::prepareRecursive ( )
privateinherited

Definition at line 97 of file Stoppable.cpp.

◆ startRecursive()

void ripple::Stoppable::startRecursive ( )
privateinherited

Definition at line 105 of file Stoppable.cpp.

◆ stopAsyncRecursive()

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

Definition at line 113 of file Stoppable.cpp.

◆ stopRecursive()

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

Definition at line 122 of file Stoppable.cpp.

Member Data Documentation

◆ app_

Application& ripple::InboundTransactionsImp::app_

Definition at line 65 of file InboundTransactions.cpp.

◆ m_clock

clock_type& ripple::InboundTransactionsImp::m_clock
private

Definition at line 274 of file InboundTransactions.cpp.

◆ mLock

std::recursive_mutex ripple::InboundTransactionsImp::mLock
private

Definition at line 278 of file InboundTransactions.cpp.

◆ m_map

MapType ripple::InboundTransactionsImp::m_map
private

Definition at line 280 of file InboundTransactions.cpp.

◆ m_seq

std::uint32_t ripple::InboundTransactionsImp::m_seq
private

Definition at line 281 of file InboundTransactions.cpp.

◆ m_zeroSet

InboundTransactionSet& ripple::InboundTransactionsImp::m_zeroSet
private

Definition at line 284 of file InboundTransactions.cpp.

◆ m_gotSet

std::function<void (std::shared_ptr <SHAMap> const&, bool)> ripple::InboundTransactionsImp::m_gotSet
private

Definition at line 286 of file InboundTransactions.cpp.

◆ m_name

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

Definition at line 322 of file Stoppable.h.

◆ m_root

RootStoppable& ripple::Stoppable::m_root
privateinherited

Definition at line 323 of file Stoppable.h.

◆ m_child

Child ripple::Stoppable::m_child
privateinherited

Definition at line 324 of file Stoppable.h.

◆ m_stopped

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

Definition at line 325 of file Stoppable.h.

◆ m_childrenStopped

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

Definition at line 326 of file Stoppable.h.

◆ m_children

Children ripple::Stoppable::m_children
privateinherited

Definition at line 327 of file Stoppable.h.

◆ m_cv

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

Definition at line 328 of file Stoppable.h.

◆ m_mut

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

Definition at line 329 of file Stoppable.h.

◆ m_is_stopping

bool ripple::Stoppable::m_is_stopping = false
privateinherited

Definition at line 330 of file Stoppable.h.

◆ hasParent_

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

Definition at line 331 of file Stoppable.h.

Generated by   doxygen 1.8.17