IndexReorgCrash Class Reference

Inheritance diagram for IndexReorgCrash:

Collaboration diagram for IndexReorgCrash:

Public Member Functions
	IndexReorgCrash (std::unique_ptr< interfaces::Chain > chain, std::shared_future< void > blocker, int blocking_height, FakeNodeClock &clock)
bool	AllowPrune () const override
BaseIndex::DB &	GetDB () const override
bool	CustomAppend (const interfaces::BlockInfo &block) override
	Write update index entries for a newly connected block.
Public Member Functions inherited from BaseIndex
	BaseIndex (std::unique_ptr< interfaces::Chain > chain, std::string name, std::string thread_name)
virtual	~BaseIndex ()
	Destructor interrupts sync thread if running and blocks until it exits.
const std::string &	GetName () const LIFETIMEBOUND
	Get the name of the index for display in logs.
virtual interfaces::Chain::NotifyOptions	CustomOptions ()
	Return custom notification options for index.
bool BlockUntilSyncedToCurrentChain() const LOCKS_EXCLUDED(void	Interrupt ()
	Blocks the current thread until the index is caught up to the current state of the block chain.
bool	Init ()
	Initializes the sync state and registers the instance to the validation interface so that it stays in sync with blockchain updates.
bool	StartBackgroundSync ()
	Starts the initial sync process on a background thread.
void	Sync ()
	Sync the index with the block index starting from the current best block.
void	Stop ()
	Stops the instance from staying in sync with blockchain updates.
IndexSummary	GetSummary () const
	Get a summary of the index and its state.

Private Attributes
FakeNodeClock &	m_clock
std::unique_ptr< BaseIndex::DB >	m_db
std::shared_future< void >	m_blocker
int	m_blocking_height

Additional Inherited Members
Protected Member Functions inherited from BaseIndex
void	BlockConnected (const kernel::ChainstateRole &role, const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex) override
	Notifies listeners of a block being connected.
void	ChainStateFlushed (const kernel::ChainstateRole &role, const CBlockLocator &locator) override
	Notifies listeners of the new active block chain on-disk.
virtual bool	CustomInit (const std::optional< interfaces::BlockRef > &block)
	Initialize internal state from the database and block index.
virtual bool	CustomCommit (CDBBatch &batch)
	Virtual method called internally by Commit that can be overridden to atomically commit more index state.
virtual bool	CustomRemove (const interfaces::BlockInfo &block)
	Rewind index by one block during a chain reorg.
void	SetBestBlockIndex (const CBlockIndex *block)
	Update the internal best block index as well as the prune lock.
Protected Member Functions inherited from CValidationInterface
	~CValidationInterface ()=default
	Protected destructor so that instances can only be deleted by derived classes.
virtual void	UpdatedBlockTip (const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload)
	Notifies listeners when the block chain tip advances.
virtual void	ActiveTipChange (const CBlockIndex &new_tip, bool is_ibd)
	Notifies listeners any time the block chain tip changes, synchronously.
virtual void	TransactionAddedToMempool (const NewMempoolTransactionInfo &tx, uint64_t mempool_sequence)
	Notifies listeners of a transaction having been added to mempool.
virtual void	TransactionRemovedFromMempool (const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence)
	Notifies listeners of a transaction leaving mempool.
virtual void	MempoolTransactionsRemovedForBlock (const std::shared_ptr< const CBlock > &block, const std::vector< RemovedMempoolTransactionInfo > &txs_removed_for_block, unsigned int block_height)
virtual void	BlockDisconnected (const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
	Notifies listeners of a block being disconnected Provides the block that was disconnected.
virtual void	BlockChecked (const std::shared_ptr< const CBlock > &, const BlockValidationState &)
	Notifies listeners of a block validation result.
virtual void	NewPoWValidBlock (const CBlockIndex *pindex, const std::shared_ptr< const CBlock > &block)
	Notifies listeners that a block which builds directly on our current tip has been received and connected to the headers tree, though not validated yet.
Protected Attributes inherited from BaseIndex
std::unique_ptr< interfaces::Chain >	m_chain
Chainstate *	m_chainstate {nullptr}
const std::string	m_name
const std::string	m_thread_name

Detailed Description

Definition at line 160 of file baseindex_tests.cpp.

Constructor & Destructor Documentation

IndexReorgCrash()

IndexReorgCrash::IndexReorgCrash ( std::unique_ptr< interfaces::Chain >  chain, std::shared_future< void >  blocker, int  blocking_height, FakeNodeClock &  clock  )

inlineexplicit

Definition at line 169 of file baseindex_tests.cpp.

Here is the call graph for this function:

Member Function Documentation

AllowPrune()

bool IndexReorgCrash::AllowPrune ( ) const

inlineoverridevirtual

Implements BaseIndex.

Definition at line 177 of file baseindex_tests.cpp.

CustomAppend()

bool IndexReorgCrash::CustomAppend ( const interfaces::BlockInfo &  block )

inlineoverridevirtual

Write update index entries for a newly connected block.

Reimplemented from BaseIndex.

Definition at line 180 of file baseindex_tests.cpp.

GetDB()

BaseIndex::DB & IndexReorgCrash::GetDB ( ) const

inlineoverridevirtual

Implements BaseIndex.

Definition at line 178 of file baseindex_tests.cpp.

Member Data Documentation

m_blocker

std::shared_future<void> IndexReorgCrash::m_blocker

private

Definition at line 165 of file baseindex_tests.cpp.

m_blocking_height

int IndexReorgCrash::m_blocking_height

private

Definition at line 166 of file baseindex_tests.cpp.

m_clock

FakeNodeClock& IndexReorgCrash::m_clock

private

Definition at line 163 of file baseindex_tests.cpp.

m_db

std::unique_ptr<BaseIndex::DB> IndexReorgCrash::m_db

private

Definition at line 164 of file baseindex_tests.cpp.

---

The documentation for this class was generated from the following file:

• src/test/baseindex_tests.cpp