ripple::Family Class Reference

Inheritance diagram for ripple::Family:

Public Member Functions
	Family (Family const &)=delete
	Family (Family &&)=delete
Family &	operator= (Family const &)=delete
Family &	operator= (Family &&)=delete
	Family ()=default
virtual	~Family ()=default
virtual NodeStore::Database &	db ()=0
virtual NodeStore::Database const &	db () const =0
virtual beast::Journal const &	journal ()=0
virtual std::shared_ptr< FullBelowCache >	getFullBelowCache (std::uint32_t ledgerSeq)=0
	Return a pointer to the Family Full Below Cache. More...
virtual std::shared_ptr< TreeNodeCache >	getTreeNodeCache (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	missingNodeAcquireBySeq (std::uint32_t refNum, uint256 const &nodeHash)=0
	Acquire ledger that has a missing node by ledger sequence. More...
virtual void	missingNodeAcquireByHash (uint256 const &refHash, std::uint32_t refNum)=0
	Acquire ledger that has a missing node by ledger hash. More...
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

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

db() [2/2]

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

pure virtual

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

journal()

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

pure virtual

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

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

ledgerSeq

ledger 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

ledgerSeq

ledger 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

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

isShardBacked()

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

pure virtual

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

missingNodeAcquireBySeq()

virtual void ripple::Family::missingNodeAcquireBySeq ( std::uint32_t  refNum, uint256 const &  nodeHash  )

pure virtual

Acquire ledger that has a missing node by ledger sequence.

Throw if in reporting mode.

Parameters

refNum	Sequence of ledger to acquire.
nodeHash	Hash of missing node to report in throw.

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

missingNodeAcquireByHash()

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

pure virtual

Acquire ledger that has a missing node by ledger hash.

Parameters

refHash	Hash of ledger to acquire.
refNum	Ledger sequence with missing node.

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

reset()

virtual void ripple::Family::reset ( )

pure virtual

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