Bitcoin ABC  0.26.3
P2P Digital Currency
validationinterface.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2016 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_VALIDATIONINTERFACE_H
7 #define BITCOIN_VALIDATIONINTERFACE_H
8 
9 #include <primitives/transaction.h> // CTransaction(Ref)
10 #include <sync.h>
11 
12 #include <functional>
13 #include <memory>
14 
15 extern RecursiveMutex cs_main;
17 class CBlock;
18 class CBlockIndex;
19 struct CBlockLocator;
20 class CConnman;
22 class uint256;
23 class CScheduler;
24 enum class MemPoolRemovalReason;
25 
35 
36 // Alternate registration functions that release a shared_ptr after the last
37 // notification is sent. These are useful for race-free cleanup, since
38 // unregistration is nonblocking and can return before the last notification is
39 // processed.
42  std::shared_ptr<CValidationInterface> callbacks);
45  std::shared_ptr<CValidationInterface> callbacks);
46 
56 void CallFunctionInValidationInterfaceQueue(std::function<void()> func);
67 
84 protected:
90  ~CValidationInterface() = default;
100  virtual void UpdatedBlockTip(const CBlockIndex *pindexNew,
101  const CBlockIndex *pindexFork,
102  bool fInitialDownload) {}
109  uint64_t mempool_sequence) {}
110 
144  MemPoolRemovalReason reason,
145  uint64_t mempool_sequence) {}
152  virtual void BlockConnected(const std::shared_ptr<const CBlock> &block,
153  const CBlockIndex *pindex) {}
159  virtual void BlockDisconnected(const std::shared_ptr<const CBlock> &block,
160  const CBlockIndex *pindex) {}
177  virtual void ChainStateFlushed(const CBlockLocator &locator) {}
184  virtual void BlockChecked(const CBlock &, const BlockValidationState &) {}
190  virtual void NewPoWValidBlock(const CBlockIndex *pindex,
191  const std::shared_ptr<const CBlock> &block){};
192 
193  virtual void BlockFinalized(const CBlockIndex *pindex){};
194 
195  friend class CMainSignals;
196 };
197 
198 struct MainSignalsInstance;
200 private:
201  std::unique_ptr<MainSignalsInstance> m_internals;
202 
204  std::shared_ptr<CValidationInterface>);
208  std::function<void()> func);
209 
210 public:
223 
224  size_t CallbacksPending();
225 
226  void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *,
227  bool fInitialDownload);
229  uint64_t mempool_sequence);
232  uint64_t mempool_sequence);
233  void BlockConnected(const std::shared_ptr<const CBlock> &,
234  const CBlockIndex *pindex);
235  void BlockDisconnected(const std::shared_ptr<const CBlock> &,
236  const CBlockIndex *pindex);
237  void ChainStateFlushed(const CBlockLocator &);
238  void BlockChecked(const CBlock &, const BlockValidationState &);
239  void NewPoWValidBlock(const CBlockIndex *,
240  const std::shared_ptr<const CBlock> &);
241  void BlockFinalized(const CBlockIndex *);
242 };
243 
245 
246 #endif // BITCOIN_VALIDATIONINTERFACE_H
Definition: block.h:55
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: blockindex.h:26
Definition: net.h:912
std::unique_ptr< MainSignalsInstance > m_internals
void TransactionAddedToMempool(const CTransactionRef &, uint64_t mempool_sequence)
void BlockConnected(const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload)
void BlockDisconnected(const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
void BlockChecked(const CBlock &, const BlockValidationState &)
void UnregisterBackgroundSignalScheduler()
Unregister a CScheduler to give callbacks which should run in the background - these callbacks will n...
void TransactionRemovedFromMempool(const CTransactionRef &, MemPoolRemovalReason, uint64_t mempool_sequence)
void BlockFinalized(const CBlockIndex *)
void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr< const CBlock > &)
void RegisterBackgroundSignalScheduler(CScheduler &scheduler)
Register a CScheduler to give callbacks which should run in the background (may only be called once)
void ChainStateFlushed(const CBlockLocator &)
void FlushBackgroundCallbacks()
Call any remaining callbacks on the calling thread.
Simple class for background tasks that should be run periodically or once "after a while".
Definition: scheduler.h:36
Implement this to subscribe to events generated in validation.
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 connec...
virtual void TransactionAddedToMempool(const CTransactionRef &tx, uint64_t mempool_sequence)
Notifies listeners of a transaction having been added to mempool.
virtual void ChainStateFlushed(const CBlockLocator &locator)
Notifies listeners of the new active block chain on-disk.
virtual void BlockChecked(const CBlock &, const BlockValidationState &)
Notifies listeners of a block validation result.
virtual void TransactionRemovedFromMempool(const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence)
Notifies listeners of a transaction leaving mempool.
virtual void UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload)
Notifies listeners when the block chain tip advances.
virtual void BlockFinalized(const CBlockIndex *pindex)
virtual void BlockConnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being connected.
virtual void BlockDisconnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being disconnected.
~CValidationInterface()=default
Protected destructor so that instances can only be deleted by derived classes.
256-bit opaque blob.
Definition: uint256.h:127
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:319
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:100
The MainSignalsInstance manages a list of shared_ptr<CValidationInterface> callbacks.
#define LOCKS_EXCLUDED(...)
Definition: threadsafety.h:55
MemPoolRemovalReason
Reason why a transaction was removed from the mempool, this is passed to the notification signal.
Definition: txmempool.h:347
CMainSignals & GetMainSignals()
void CallFunctionInValidationInterfaceQueue(std::function< void()> func)
Pushes a function to callback onto the notification queue, guaranteeing any callbacks generated prior...
void UnregisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Unregister subscriber.
void SyncWithValidationInterfaceQueue() LOCKS_EXCLUDED(cs_main)
This is a synonym for the following, which asserts certain locks are not held: std::promise<void> pro...
void UnregisterAllValidationInterfaces()
Unregister all subscribers.
void UnregisterValidationInterface(CValidationInterface *callbacks)
Unregister subscriber.
RecursiveMutex cs_main
Global state.
Definition: validation.cpp:111
void RegisterValidationInterface(CValidationInterface *callbacks)
Register subscriber.
void RegisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Register subscriber.