#include <zmqnotificationinterface.h>

Inheritance diagram for CZMQNotificationInterface:

Collaboration diagram for CZMQNotificationInterface:

Public Member Functions
virtual	~CZMQNotificationInterface ()

std::list< const CZMQAbstractNotifier * >	GetActiveNotifiers () const

Static Public Member Functions
static std::unique_ptr< CZMQNotificationInterface >	Create (std::function< bool(CBlock &, const CBlockIndex &)> get_block_by_index)

Protected Member Functions
bool	Initialize ()

void	Shutdown ()

void	TransactionAddedToMempool (const CTransactionRef &tx, std::shared_ptr< const std::vector< Coin > >, uint64_t mempool_sequence) override
	Notifies listeners of a transaction having been added to mempool. More...

void	TransactionRemovedFromMempool (const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence) override
	Notifies listeners of a transaction leaving mempool. More...

void	BlockConnected (ChainstateRole role, const std::shared_ptr< const CBlock > &pblock, const CBlockIndex *pindexConnected) override
	Notifies listeners of a block being connected. More...

void	BlockDisconnected (const std::shared_ptr< const CBlock > &pblock, const CBlockIndex *pindexDisconnected) override
	Notifies listeners of a block being disconnected. More...

void	UpdatedBlockTip (const CBlockIndex pindexNew, const CBlockIndex pindexFork, bool fInitialDownload) override
	Notifies listeners when the block chain tip advances. 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 &tx, std::shared_ptr< const std::vector< Coin > > spent_coins, uint64_t mempool_sequence)
	Notifies listeners of a transaction having been added to mempool. More...

virtual void	TransactionRemovedFromMempool (const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence)
	Notifies listeners of a transaction leaving mempool. More...

virtual void	BlockConnected (ChainstateRole role, const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
	Notifies listeners of a block being connected. More...

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

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

virtual void	BlockChecked (const CBlock &, const BlockValidationState &)
	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	BlockFinalized (const CBlockIndex *pindex)

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

Private Member Functions
	CZMQNotificationInterface ()

Private Attributes
void *	pcontext

std::list< std::unique_ptr< CZMQAbstractNotifier > >	notifiers

Detailed Description

Definition at line 17 of file zmqnotificationinterface.h.

Constructor & Destructor Documentation

◆ ~CZMQNotificationInterface()

CZMQNotificationInterface::~CZMQNotificationInterface ( )

virtual

Definition at line 18 of file zmqnotificationinterface.cpp.

Here is the call graph for this function:

◆ CZMQNotificationInterface()

CZMQNotificationInterface::CZMQNotificationInterface ( )

private

Definition at line 16 of file zmqnotificationinterface.cpp.

Here is the caller graph for this function:

Member Function Documentation

◆ BlockConnected()

void CZMQNotificationInterface::BlockConnected	(	ChainstateRole	role,
		const std::shared_ptr< const CBlock > &	block,
		const CBlockIndex *	pindex
	)

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 178 of file zmqnotificationinterface.cpp.

Here is the call graph for this function:

◆ BlockDisconnected()

void CZMQNotificationInterface::BlockDisconnected	(	const std::shared_ptr< const CBlock > &	block,
		const CBlockIndex *	pindex
	)

overrideprotectedvirtual

Notifies listeners of a block being disconnected.

Called on a background thread. Only called for the active chainstate, since background chainstates should never disconnect blocks.

Reimplemented from CValidationInterface.

Definition at line 199 of file zmqnotificationinterface.cpp.

Here is the call graph for this function:

◆ Create()

std::unique_ptr< CZMQNotificationInterface > CZMQNotificationInterface::Create ( std::function< bool(CBlock &, const CBlockIndex &)> get_block_by_index )

static

Definition at line 31 of file zmqnotificationinterface.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetActiveNotifiers()

std::list< const CZMQAbstractNotifier * > CZMQNotificationInterface::GetActiveNotifiers ( ) const

Definition at line 23 of file zmqnotificationinterface.cpp.

◆ Initialize()

bool CZMQNotificationInterface::Initialize ( )

protected

Definition at line 77 of file zmqnotificationinterface.cpp.

Here is the call graph for this function:

◆ Shutdown()

void CZMQNotificationInterface::Shutdown ( )

protected

Definition at line 107 of file zmqnotificationinterface.cpp.

Here is the caller graph for this function:

◆ TransactionAddedToMempool()

void CZMQNotificationInterface::TransactionAddedToMempool	(	const CTransactionRef &	tx,
		std::shared_ptr< const std::vector< Coin > >	spent_coins,
		uint64_t	mempool_sequence
	)

overrideprotectedvirtual

Notifies listeners of a transaction having been added to mempool.

Called on a background thread.

Reimplemented from CValidationInterface.

Definition at line 154 of file zmqnotificationinterface.cpp.

Here is the call graph for this function:

◆ TransactionRemovedFromMempool()

void CZMQNotificationInterface::TransactionRemovedFromMempool	(	const CTransactionRef &	tx,
		MemPoolRemovalReason	reason,
		uint64_t	mempool_sequence
	)

overrideprotectedvirtual

Notifies listeners of a transaction leaving mempool.

This notification fires for transactions that are removed from the mempool for the following reasons:

EXPIRY (expired from mempool after -mempoolexpiry hours)
SIZELIMIT (removed in size limiting if the mempool exceeds -maxmempool megabytes)
REORG (removed during a reorg)
CONFLICT (removed because it conflicts with in-block transaction)

This does not fire for transactions that are removed from the mempool because they have been included in a block. Any client that is interested in transactions removed from the mempool for inclusion in a block can learn about those transactions from the BlockConnected notification.

Transactions that are removed from the mempool because they conflict with a transaction in the new block will have TransactionRemovedFromMempool events fired before the BlockConnected event is fired. If multiple blocks are connected in one step, then the ordering could be:

TransactionRemovedFromMempool(tx1 from block A)
TransactionRemovedFromMempool(tx2 from block A)
TransactionRemovedFromMempool(tx1 from block B)
TransactionRemovedFromMempool(tx2 from block B)
BlockConnected(A)
BlockConnected(B)

Called on a background thread.

Reimplemented from CValidationInterface.

Definition at line 166 of file zmqnotificationinterface.cpp.

Here is the call graph for this function:

◆ UpdatedBlockTip()

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

overrideprotectedvirtual

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. Only called for the active chainstate.

Reimplemented from CValidationInterface.

Definition at line 140 of file zmqnotificationinterface.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ notifiers

std::list<std::unique_ptr<CZMQAbstractNotifier> > CZMQNotificationInterface::notifiers

private

Definition at line 50 of file zmqnotificationinterface.h.

◆ pcontext

void* CZMQNotificationInterface::pcontext

private

Definition at line 49 of file zmqnotificationinterface.h.

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

/work/src/zmq/zmqnotificationinterface.h
/work/src/zmq/zmqnotificationinterface.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~CZMQNotificationInterface()

◆ CZMQNotificationInterface()

Member Function Documentation

◆ BlockConnected()

◆ BlockDisconnected()

◆ Create()

◆ GetActiveNotifiers()

◆ Initialize()

◆ Shutdown()

◆ TransactionAddedToMempool()

◆ TransactionRemovedFromMempool()

◆ UpdatedBlockTip()

Member Data Documentation

◆ notifiers

◆ pcontext