Bitcoin Core  26.99.0
P2P Digital Currency
clientmodel.h
Go to the documentation of this file.
1 // Copyright (c) 2011-2022 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #ifndef BITCOIN_QT_CLIENTMODEL_H
6 #define BITCOIN_QT_CLIENTMODEL_H
7 
8 #include <QObject>
9 #include <QDateTime>
10 
11 #include <atomic>
12 #include <memory>
13 #include <sync.h>
14 #include <uint256.h>
15 
16 class BanTableModel;
17 class CBlockIndex;
18 class OptionsModel;
19 class PeerTableModel;
20 class PeerTableSortProxy;
21 enum class SynchronizationState;
22 
23 namespace interfaces {
24 class Handler;
25 class Node;
26 struct BlockTip;
27 }
28 
29 QT_BEGIN_NAMESPACE
30 class QTimer;
31 QT_END_NAMESPACE
32 
33 enum class BlockSource {
34  NONE,
35  DISK,
36  NETWORK,
37 };
38 
39 enum class SyncType {
43 };
44 
47  CONNECTIONS_IN = (1U << 0),
48  CONNECTIONS_OUT = (1U << 1),
50 };
51 
53 class ClientModel : public QObject
54 {
55  Q_OBJECT
56 
57 public:
58  explicit ClientModel(interfaces::Node& node, OptionsModel *optionsModel, QObject *parent = nullptr);
59  ~ClientModel();
60 
61  interfaces::Node& node() const { return m_node; }
66 
68  int getNumConnections(unsigned int flags = CONNECTIONS_ALL) const;
69  int getNumBlocks() const;
71  int getHeaderTipHeight() const;
72  int64_t getHeaderTipTime() const;
73 
77  QString getStatusBarWarnings() const;
78 
79  QString formatFullVersion() const;
80  QString formatSubVersion() const;
81  bool isReleaseVersion() const;
82  QString formatClientStartupTime() const;
83  QString dataDir() const;
84  QString blocksDir() const;
85 
86  bool getProxyInfo(std::string& ip_port) const;
87 
88  // caches for the best header: hash, number of blocks and block time
89  mutable std::atomic<int> cachedBestHeaderHeight;
90  mutable std::atomic<int64_t> cachedBestHeaderTime;
91  mutable std::atomic<int> m_cached_num_blocks{-1};
92 
94  uint256 m_cached_tip_blocks GUARDED_BY(m_cached_tip_mutex){};
95 
96 private:
98  std::unique_ptr<interfaces::Handler> m_handler_show_progress;
99  std::unique_ptr<interfaces::Handler> m_handler_notify_num_connections_changed;
100  std::unique_ptr<interfaces::Handler> m_handler_notify_network_active_changed;
101  std::unique_ptr<interfaces::Handler> m_handler_notify_alert_changed;
102  std::unique_ptr<interfaces::Handler> m_handler_banned_list_changed;
103  std::unique_ptr<interfaces::Handler> m_handler_notify_block_tip;
104  std::unique_ptr<interfaces::Handler> m_handler_notify_header_tip;
109 
111  QThread* const m_thread;
112 
113  void TipChanged(SynchronizationState sync_state, interfaces::BlockTip tip, double verification_progress, SyncType synctype) EXCLUSIVE_LOCKS_REQUIRED(!m_cached_tip_mutex);
114  void subscribeToCoreSignals();
116 
117 Q_SIGNALS:
119  void numBlocksChanged(int count, const QDateTime& blockDate, double nVerificationProgress, SyncType header, SynchronizationState sync_state);
120  void mempoolSizeChanged(long count, size_t mempoolSizeInBytes);
121  void networkActiveChanged(bool networkActive);
122  void alertsChanged(const QString &warnings);
123  void bytesChanged(quint64 totalBytesIn, quint64 totalBytesOut);
124 
126  void message(const QString &title, const QString &message, unsigned int style);
127 
128  // Show progress dialog e.g. for verifychain
129  void showProgress(const QString &title, int nProgress);
130 };
131 
132 #endif // BITCOIN_QT_CLIENTMODEL_H
int flags
Definition: bitcoin-tx.cpp:528
Qt model providing information about banned peers, similar to the "getpeerinfo" RPC call.
Definition: bantablemodel.h:44
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:145
Model for Bitcoin network client.
Definition: clientmodel.h:54
std::unique_ptr< interfaces::Handler > m_handler_banned_list_changed
Definition: clientmodel.h:102
void bytesChanged(quint64 totalBytesIn, quint64 totalBytesOut)
void showProgress(const QString &title, int nProgress)
QString blocksDir() const
QString getStatusBarWarnings() const
Return warnings to be displayed in status bar.
int getHeaderTipHeight() const
Definition: clientmodel.cpp:91
std::unique_ptr< interfaces::Handler > m_handler_show_progress
Definition: clientmodel.h:98
std::atomic< int64_t > cachedBestHeaderTime
Definition: clientmodel.h:90
std::unique_ptr< interfaces::Handler > m_handler_notify_alert_changed
Definition: clientmodel.h:101
interfaces::Node & m_node
Definition: clientmodel.h:94
interfaces::Node & node() const
Definition: clientmodel.h:61
Mutex m_cached_tip_mutex
Definition: clientmodel.h:93
PeerTableModel * getPeerTableModel()
PeerTableSortProxy * peerTableSortProxy()
std::atomic< int > cachedBestHeaderHeight
Definition: clientmodel.h:89
uint256 getBestBlockHash() EXCLUSIVE_LOCKS_REQUIRED(!m_cached_tip_mutex)
void message(const QString &title, const QString &message, unsigned int style)
Fired when a message should be reported to the user.
void numConnectionsChanged(int count)
BlockSource getBlockSource() const
Returns the block source of the current importing/syncing state.
int getNumBlocks() const
int64_t getHeaderTipTime() const
std::unique_ptr< interfaces::Handler > m_handler_notify_block_tip
Definition: clientmodel.h:103
uint256 m_cached_tip_blocks GUARDED_BY(m_cached_tip_mutex)
Definition: clientmodel.h:94
QString formatClientStartupTime() const
int getNumConnections(unsigned int flags=CONNECTIONS_ALL) const
Return number of connections, default is in- and outbound (total)
Definition: clientmodel.cpp:77
ClientModel(interfaces::Node &node, OptionsModel *optionsModel, QObject *parent=nullptr)
Definition: clientmodel.cpp:34
std::unique_ptr< interfaces::Handler > m_handler_notify_num_connections_changed
Definition: clientmodel.h:99
std::unique_ptr< interfaces::Handler > m_handler_notify_network_active_changed
Definition: clientmodel.h:100
OptionsModel * optionsModel
Definition: clientmodel.h:105
BanTableModel * banTableModel
Definition: clientmodel.h:108
QThread *const m_thread
A thread to interact with m_node asynchronously.
Definition: clientmodel.h:111
std::unique_ptr< interfaces::Handler > m_handler_notify_header_tip
Definition: clientmodel.h:104
BanTableModel * getBanTableModel()
void unsubscribeFromCoreSignals()
void numBlocksChanged(int count, const QDateTime &blockDate, double nVerificationProgress, SyncType header, SynchronizationState sync_state)
void TipChanged(SynchronizationState sync_state, interfaces::BlockTip tip, double verification_progress, SyncType synctype) EXCLUSIVE_LOCKS_REQUIRED(!m_cached_tip_mutex)
void alertsChanged(const QString &warnings)
QString dataDir() const
std::atomic< int > m_cached_num_blocks
Definition: clientmodel.h:91
OptionsModel * getOptionsModel()
QString formatFullVersion() const
PeerTableModel * peerTableModel
Definition: clientmodel.h:106
PeerTableSortProxy * m_peer_table_sort_proxy
Definition: clientmodel.h:107
bool getProxyInfo(std::string &ip_port) const
QString formatSubVersion() const
void mempoolSizeChanged(long count, size_t mempoolSizeInBytes)
bool isReleaseVersion() const
void subscribeToCoreSignals()
void networkActiveChanged(bool networkActive)
Interface from Qt to configuration data structure for Bitcoin client.
Definition: optionsmodel.h:41
Qt model providing information about connected peers, similar to the "getpeerinfo" RPC call.
Top-level interface for a bitcoin node (bitcoind process).
Definition: node.h:70
256-bit opaque blob.
Definition: uint256.h:106
SyncType
Definition: clientmodel.h:39
@ HEADER_PRESYNC
NumConnections
Definition: clientmodel.h:45
@ CONNECTIONS_IN
Definition: clientmodel.h:47
@ CONNECTIONS_NONE
Definition: clientmodel.h:46
@ CONNECTIONS_OUT
Definition: clientmodel.h:48
@ CONNECTIONS_ALL
Definition: clientmodel.h:49
BlockSource
Definition: clientmodel.h:33
Definition: init.h:25
Block tip (could be a header or not, depends on the subscribed signal).
Definition: node.h:276
static int count
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:84