Implement this to subscribe to events generated in validation. More...

#include <validationinterface.h>

Inheritance diagram for CValidationInterface:

Protected Member Functions
	~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	BlockConnected (const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex, const std::vector< CTransactionRef > &txnConflicted)
	Notifies listeners of a block being connected. More...

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

virtual void	ChainStateFlushed (const CBlockLocator &locator)
	Notifies listeners of the new active block chain on-disk. 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 ()

Detailed Description

Implement this to subscribe to events generated in validation.

Each CValidationInterface() subscriber will receive event callbacks in the order in which the events were generated by validation. Furthermore, each ValidationInterface() subscriber may assume that callbacks effectively run in a single thread with single-threaded memory consistency. That is, for a given ValidationInterface() instantiation, each callback will complete before the next one is invoked. This means, for example when a block is connected that the UpdatedBlockTip() callback may depend on an operation performed in the BlockConnected() callback without worrying about explicit synchronization. No ordering should be assumed across ValidationInterface() subscribers.

Definition at line 73 of file validationinterface.h.

Constructor & Destructor Documentation

◆ ~CValidationInterface()

CValidationInterface::~CValidationInterface ( )

protecteddefault

Protected destructor so that instances can only be deleted by derived classes.

If that restriction is no longer desired, this should be made public and virtual.

Member Function Documentation

◆ BlockChecked()

virtual void CValidationInterface::BlockChecked	(	const CBlock &	,
		const CValidationState &
	)

inlineprotectedvirtual

Notifies listeners of a block validation result.

If the provided CValidationState IsValid, the provided block is guaranteed to be the current best block at the time the callback was generated (not necessarily now)

Reimplemented in submitblock_StateCatcher, and PeerLogicValidation.

Definition at line 145 of file validationinterface.h.

◆ BlockConnected()

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

inlineprotectedvirtual

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 in CWallet, BaseIndex, PeerLogicValidation, and CZMQNotificationInterface.

Definition at line 113 of file validationinterface.h.

◆ BlockDisconnected()

virtual void CValidationInterface::BlockDisconnected ( const std::shared_ptr< const CBlock > & block )

inlineprotectedvirtual

Notifies listeners of a block being disconnected.

Called on a background thread.

Reimplemented in CWallet, and CZMQNotificationInterface.

Definition at line 119 of file validationinterface.h.

◆ BlockFound()

virtual void CValidationInterface::BlockFound ( const uint256 & hash )

inlineprotectedvirtual

Definition at line 151 of file validationinterface.h.

◆ ChainStateFlushed()

virtual void CValidationInterface::ChainStateFlushed ( const CBlockLocator & locator )

inlineprotectedvirtual

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 in CWallet, and BaseIndex.

Definition at line 136 of file validationinterface.h.

◆ NewPoWValidBlock()

virtual void CValidationInterface::NewPoWValidBlock	(	const CBlockIndex *	pindex,
		const std::shared_ptr< const CBlock > &	block
	)

inlineprotectedvirtual

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.

Reimplemented in PeerLogicValidation.

Definition at line 149 of file validationinterface.h.

◆ ResendWalletTransactions()

virtual void CValidationInterface::ResendWalletTransactions	(	int64_t	nBestBlockTime,
		CConnman *	connman
	)

inlineprotectedvirtual

Tells listeners to broadcast their data.

Reimplemented in CWallet.

Definition at line 138 of file validationinterface.h.

◆ TransactionAddedToMempool()

virtual void CValidationInterface::TransactionAddedToMempool ( const CTransactionRef & ptxn )

inlineprotectedvirtual

Notifies listeners of a transaction having been added to mempool.

Called on a background thread.

Reimplemented in CWallet, and CZMQNotificationInterface.

Definition at line 95 of file validationinterface.h.

◆ TransactionRemovedFromMempool()

virtual void CValidationInterface::TransactionRemovedFromMempool ( const CTransactionRef & ptx )

inlineprotectedvirtual

Notifies listeners of a transaction leaving mempool.

This only fires for transactions which leave mempool because of expiry, size limiting, reorg (changes in lock times/coinbase maturity), or replacement. This does not include any transactions which are included in BlockConnectedDisconnected either in block->vtx or in txnConflicted.

Called on a background thread.

Reimplemented in CWallet.

Definition at line 106 of file validationinterface.h.

◆ UpdatedBlockTip()

virtual void CValidationInterface::UpdatedBlockTip	(	const CBlockIndex *	pindexNew,
		const CBlockIndex *	pindexFork,
		bool	fInitialDownload
	)

inlineprotectedvirtual

Notifies listeners when the block chain tip advances.

When multiple blocks are connected at once, UpdatedBlockTip will be called on the final tip but may not be called on every intermediate tip. If the latter behavior is desired, subscribe to BlockConnected() instead.

Called on a background thread.

Reimplemented in PeerLogicValidation, and CZMQNotificationInterface.

Definition at line 89 of file validationinterface.h.

◆ void ::RegisterValidationInterface()

CValidationInterface::void ::RegisterValidationInterface ( CValidationInterface * )

protected

◆ void ::UnregisterAllValidationInterfaces()

CValidationInterface::void ::UnregisterAllValidationInterfaces ( )

protected

◆ void ::UnregisterValidationInterface()

CValidationInterface::void ::UnregisterValidationInterface ( CValidationInterface * )

protected

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

src/validationinterface.h

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~CValidationInterface()

Member Function Documentation

◆ BlockChecked()

◆ BlockConnected()

◆ BlockDisconnected()

◆ BlockFound()

◆ ChainStateFlushed()

◆ NewPoWValidBlock()

◆ ResendWalletTransactions()

◆ TransactionAddedToMempool()

◆ TransactionRemovedFromMempool()

◆ UpdatedBlockTip()

◆ void ::RegisterValidationInterface()

◆ void ::UnregisterAllValidationInterfaces()

◆ void ::UnregisterValidationInterface()