validationinterface.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2016 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_VALIDATIONINTERFACE_H
#define BITCOIN_VALIDATIONINTERFACE_H

#include <primitives/transaction.h> // CTransaction(Ref)
#include <sync.h>

#include <functional>
#include <memory>

extern RecursiveMutex cs_main;
class BlockValidationState;
class CBlock;
class CBlockIndex;
struct CBlockLocator;
class CConnman;
class CValidationInterface;
class uint256;
class CScheduler;

// These functions dispatch to one or all registered wallets

void RegisterValidationInterface(CValidationInterface *pwalletIn);
void UnregisterValidationInterface(CValidationInterface *pwalletIn);
void UnregisterAllValidationInterfaces();

// Alternate registration functions that release a shared_ptr after the last
// notification is sent. These are useful for race-free cleanup, since
// unregistration is nonblocking and can return before the last notification is
// processed.
void RegisterSharedValidationInterface(
    std::shared_ptr<CValidationInterface> callbacks);
void UnregisterSharedValidationInterface(
    std::shared_ptr<CValidationInterface> callbacks);

void CallFunctionInValidationInterfaceQueue(std::function<void()> func);
void SyncWithValidationInterfaceQueue() LOCKS_EXCLUDED(cs_main);

class CValidationInterface {
protected:
    ~CValidationInterface() = default;
    virtual void UpdatedBlockTip(const CBlockIndex *pindexNew,
                                 const CBlockIndex *pindexFork,
                                 bool fInitialDownload) {}
    virtual void TransactionAddedToMempool(const CTransactionRef &ptxn) {}
    virtual void TransactionRemovedFromMempool(const CTransactionRef &ptx) {}
    virtual void BlockConnected(const std::shared_ptr<const CBlock> &block,
                                const CBlockIndex *pindex) {}
    virtual void BlockDisconnected(const std::shared_ptr<const CBlock> &block,
                                   const CBlockIndex *pindex) {}
    virtual void ChainStateFlushed(const CBlockLocator &locator) {}
    virtual void BlockChecked(const CBlock &, const BlockValidationState &) {}
    virtual void NewPoWValidBlock(const CBlockIndex *pindex,
                                  const std::shared_ptr<const CBlock> &block){};
    friend class CMainSignals;
};

struct MainSignalsInstance;
class CMainSignals {
private:
    std::unique_ptr<MainSignalsInstance> m_internals;

    friend void ::RegisterSharedValidationInterface(
        std::shared_ptr<CValidationInterface>);
    friend void ::UnregisterValidationInterface(CValidationInterface *);
    friend void ::UnregisterAllValidationInterfaces();
    friend void ::CallFunctionInValidationInterfaceQueue(
        std::function<void()> func);

public:
    void RegisterBackgroundSignalScheduler(CScheduler &scheduler);
    void UnregisterBackgroundSignalScheduler();
    void FlushBackgroundCallbacks();

    size_t CallbacksPending();

    void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *,
                         bool fInitialDownload);
    void TransactionAddedToMempool(const CTransactionRef &);
    void TransactionRemovedFromMempool(const CTransactionRef &);
    void BlockConnected(const std::shared_ptr<const CBlock> &,
                        const CBlockIndex *pindex);
    void BlockDisconnected(const std::shared_ptr<const CBlock> &,
                           const CBlockIndex *pindex);
    void ChainStateFlushed(const CBlockLocator &);
    void BlockChecked(const CBlock &, const BlockValidationState &);
    void NewPoWValidBlock(const CBlockIndex *,
                          const std::shared_ptr<const CBlock> &);
};

CMainSignals &GetMainSignals();

#endif // BITCOIN_VALIDATIONINTERFACE_H