Base class for indices of blockchain data. More...

#include <base.h>

Inheritance diagram for BaseIndex:

Collaboration diagram for BaseIndex:

Classes
class	DB

Public Member Functions
virtual	~BaseIndex ()
	Destructor interrupts sync thread if running and blocks until it exits. More...

bool	BlockUntilSyncedToCurrentChain ()
	Blocks the current thread until the index is caught up to the current state of the block chain. More...

void	Interrupt ()

void	Start ()
	Start initializes the sync state and registers the instance as a ValidationInterface so that it stays in sync with blockchain updates. More...

void	Stop ()
	Stops the instance from staying in sync with blockchain updates. More...

Protected Member Functions
void	BlockConnected (const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex, const std::vector< CTransactionRef > &txn_conflicted) override
	Notifies listeners of a block being connected. More...

void	ChainStateFlushed (const CBlockLocator &locator) override
	Notifies listeners of the new active block chain on-disk. More...

virtual bool	Init ()
	Initialize internal state from the database and block index. More...

virtual bool	WriteBlock (const CBlock &block, const CBlockIndex *pindex)
	Write update index entries for a newly connected block. More...

virtual DB &	GetDB () const =0

virtual const char *	GetName () const =0
	Get the name of the index for display in logs. More...

Protected Member Functions inherited from CValidationInterface
	~CValidationInterface ()=default
	Protected destructor so that instances can only be deleted by derived classes. More...

virtual void	UpdatedBlockTip (const CBlockIndex pindexNew, const CBlockIndex pindexFork, bool fInitialDownload)
	Notifies listeners when the block chain tip advances. More...

virtual void	TransactionAddedToMempool (const CTransactionRef &ptxn)
	Notifies listeners of a transaction having been added to mempool. More...

virtual void	TransactionRemovedFromMempool (const CTransactionRef &ptx)
	Notifies listeners of a transaction leaving mempool. More...

virtual void	BlockDisconnected (const std::shared_ptr< const CBlock > &block)
	Notifies listeners of a block being disconnected. More...

virtual void	ResendWalletTransactions (int64_t nBestBlockTime, CConnman *connman)
	Tells listeners to broadcast their data. More...

virtual void	BlockChecked (const CBlock &, const CValidationState &)
	Notifies listeners of a block validation result. More...

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. More...

virtual void	BlockFound (const uint256 &hash)

friend	void ::RegisterValidationInterface (CValidationInterface *)

friend	void ::UnregisterValidationInterface (CValidationInterface *)

friend	void ::UnregisterAllValidationInterfaces ()

Private Member Functions
void	ThreadSync ()
	Sync the index with the block index starting from the current best block. More...

bool	WriteBestBlock (const CBlockIndex *block_index)
	Write the current chain block locator to the DB. More...

Private Attributes
std::atomic< bool >	m_synced {false}
	Whether the index is in sync with the main chain. More...

std::atomic< const CBlockIndex * >	m_best_block_index {nullptr}
	The last block in the chain that the index is in sync with. More...

std::thread	m_thread_sync

CThreadInterrupt	m_interrupt

Detailed Description

Base class for indices of blockchain data.

This implements CValidationInterface and ensures blocks are indexed sequentially according to their position in the active chain.

Definition at line 22 of file base.h.

Constructor & Destructor Documentation

◆ ~BaseIndex()

BaseIndex::~BaseIndex ( )

virtual

Destructor interrupts sync thread if running and blocks until it exits.

Definition at line 49 of file base.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ BlockConnected()

void BaseIndex::BlockConnected	(	const std::shared_ptr< const CBlock > &	block,
		const CBlockIndex *	pindex,
		const std::vector< CTransactionRef > &	txnConflicted
	)

overrideprotectedvirtual

Notifies listeners of a block being connected.

Provides a vector of transactions evicted from the mempool as a result.

Called on a background thread.

Reimplemented from CValidationInterface.

Definition at line 152 of file base.cpp.

◆ BlockUntilSyncedToCurrentChain()

bool BaseIndex::BlockUntilSyncedToCurrentChain ( )

Blocks the current thread until the index is caught up to the current state of the block chain.

This only blocks if the index has gotten in sync once and only needs to process blocks in the ValidationInterface queue. If the index is catching up from far behind, this method does not block and immediately returns false.

Definition at line 228 of file base.cpp.

Here is the call graph for this function:

◆ ChainStateFlushed()

void BaseIndex::ChainStateFlushed ( const CBlockLocator & locator )

overrideprotectedvirtual

Notifies listeners of the new active block chain on-disk.

Prior to this callback, any updates are not guaranteed to persist on disk (ie clients need to handle shutdown/restart safety by being able to understand when some updates were lost due to unclean shutdown).

When this callback is invoked, the validation changes done by any prior callback are guaranteed to exist on disk and survive a restart, including an unclean shutdown.

Provides a locator describing the best chain, which is likely useful for storing current state on disk in client DBs.

Called on a background thread.

Reimplemented from CValidationInterface.

Definition at line 190 of file base.cpp.

Here is the call graph for this function:

◆ GetDB()

virtual DB& BaseIndex::GetDB ( ) const

protectedpure virtual

Implemented in TxIndex.

Here is the caller graph for this function:

◆ GetName()

virtual const char* BaseIndex::GetName ( ) const

protectedpure virtual

Get the name of the index for display in logs.

Implemented in TxIndex.

◆ Init()

bool BaseIndex::Init ( )

protectedvirtual

Initialize internal state from the database and block index.

Reimplemented in TxIndex.

Definition at line 55 of file base.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Interrupt()

void BaseIndex::Interrupt ( )

Definition at line 252 of file base.cpp.

Here is the caller graph for this function:

◆ Start()

void BaseIndex::Start ( )

Start initializes the sync state and registers the instance as a ValidationInterface so that it stays in sync with blockchain updates.

Definition at line 257 of file base.cpp.

Here is the call graph for this function:

◆ Stop()

void BaseIndex::Stop ( )

Stops the instance from staying in sync with blockchain updates.

Definition at line 271 of file base.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ThreadSync()

void BaseIndex::ThreadSync ( )

private

Sync the index with the block index starting from the current best block.

Intended to be run in its own thread, m_thread_sync, and can be interrupted with m_interrupt. Once the index gets in sync, the m_synced flag is set and the BlockConnected ValidationInterface callback takes over and the sync thread exits.

Definition at line 84 of file base.cpp.

Here is the call graph for this function:

◆ WriteBestBlock()

bool BaseIndex::WriteBestBlock ( const CBlockIndex * block_index )

private

Write the current chain block locator to the DB.

Definition at line 143 of file base.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteBlock()

virtual bool BaseIndex::WriteBlock	(	const CBlock &	block,
		const CBlockIndex *	pindex
	)

inlineprotectedvirtual

Write update index entries for a newly connected block.

Reimplemented in TxIndex.

Definition at line 70 of file base.h.

Member Data Documentation

◆ m_best_block_index

std::atomic<const CBlockIndex*> BaseIndex::m_best_block_index {nullptr}

private

The last block in the chain that the index is in sync with.

Definition at line 45 of file base.h.

◆ m_interrupt

CThreadInterrupt BaseIndex::m_interrupt

private

Definition at line 48 of file base.h.

◆ m_synced

std::atomic<bool> BaseIndex::m_synced {false}

private

Whether the index is in sync with the main chain.

The flag is flipped from false to true once, after which point this starts processing ValidationInterface notifications to stay in sync.

Definition at line 42 of file base.h.

◆ m_thread_sync

std::thread BaseIndex::m_thread_sync

private

Definition at line 47 of file base.h.

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

src/index/base.h
src/index/base.cpp

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~BaseIndex()

Member Function Documentation

◆ BlockConnected()

◆ BlockUntilSyncedToCurrentChain()

◆ ChainStateFlushed()

◆ GetDB()

◆ GetName()

◆ Init()

◆ Interrupt()

◆ Start()

◆ Stop()

◆ ThreadSync()

◆ WriteBestBlock()

◆ WriteBlock()

Member Data Documentation

◆ m_best_block_index

◆ m_interrupt

◆ m_synced

◆ m_thread_sync