rippled
Public Member Functions | List of all members
ripple::Family Class Referenceabstract
Inheritance diagram for ripple::Family:
Inheritance graph
[legend]

Public Member Functions

 Family (Family const &)=delete
 
 Family (Family &&)=delete
 
Familyoperator= (Family const &)=delete
 
Familyoperator= (Family &&)=delete
 
 Family ()=default
 
virtual ~Family ()=default
 
virtual NodeStore::Databasedb ()=0
 
virtual NodeStore::Database const & db () const =0
 
virtual beast::Journal const & journal ()=0
 
virtual std::shared_ptr< FullBelowCachegetFullBelowCache (std::uint32_t ledgerSeq)=0
 Return a pointer to the Family Full Below Cache. More...
 
virtual std::shared_ptr< TreeNodeCachegetTreeNodeCache (std::uint32_t ledgerSeq)=0
 Return a pointer to the Family Tree Node Cache. More...
 
virtual void sweep ()=0
 
virtual bool isShardBacked () const =0
 
virtual void missingNode (std::uint32_t refNum)=0
 
virtual void missingNode (uint256 const &refHash, std::uint32_t refNum)=0
 
virtual void reset ()=0
 

Detailed Description

Definition at line 32 of file Family.h.

Constructor & Destructor Documentation

◆ Family() [1/3]

ripple::Family::Family ( Family const &  )
delete

◆ Family() [2/3]

ripple::Family::Family ( Family &&  )
delete

◆ Family() [3/3]

ripple::Family::Family ( )
explicitdefault

◆ ~Family()

virtual ripple::Family::~Family ( )
virtualdefault

Member Function Documentation

◆ operator=() [1/2]

Family& ripple::Family::operator= ( Family const &  )
delete

◆ operator=() [2/2]

Family& ripple::Family::operator= ( Family &&  )
delete

◆ db() [1/2]

virtual NodeStore::Database& ripple::Family::db ( )
pure virtual

◆ db() [2/2]

virtual NodeStore::Database const& ripple::Family::db ( ) const
pure virtual

◆ journal()

virtual beast::Journal const& ripple::Family::journal ( )
pure virtual

◆ getFullBelowCache()

virtual std::shared_ptr<FullBelowCache> ripple::Family::getFullBelowCache ( std::uint32_t  ledgerSeq)
pure virtual

Return a pointer to the Family Full Below Cache.

Parameters
ledgerSeqledger sequence determines a corresponding shard cache
Note
ledgerSeq is used by ShardFamily and ignored by NodeFamily

Implemented in ripple::tests::TestNodeFamily, ripple::NodeFamily, and ripple::ShardFamily.

◆ getTreeNodeCache()

virtual std::shared_ptr<TreeNodeCache> ripple::Family::getTreeNodeCache ( std::uint32_t  ledgerSeq)
pure virtual

Return a pointer to the Family Tree Node Cache.

Parameters
ledgerSeqledger sequence determines a corresponding shard cache
Note
ledgerSeq is used by ShardFamily and ignored by NodeFamily

Implemented in ripple::tests::TestNodeFamily, ripple::NodeFamily, and ripple::ShardFamily.

◆ sweep()

virtual void ripple::Family::sweep ( )
pure virtual

◆ isShardBacked()

virtual bool ripple::Family::isShardBacked ( ) const
pure virtual

◆ missingNode() [1/2]

virtual void ripple::Family::missingNode ( std::uint32_t  refNum)
pure virtual

◆ missingNode() [2/2]

virtual void ripple::Family::missingNode ( uint256 const &  refHash,
std::uint32_t  refNum 
)
pure virtual

◆ reset()

virtual void ripple::Family::reset ( )
pure virtual