Bitcoin Core  25.99.0
P2P Digital Currency
kernel_notifications.h
Go to the documentation of this file.
1 // Copyright (c) 2023 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_NODE_KERNEL_NOTIFICATIONS_H
6 #define BITCOIN_NODE_KERNEL_NOTIFICATIONS_H
7 
9 
10 #include <atomic>
11 #include <cstdint>
12 #include <string>
13 
14 class ArgsManager;
15 class CBlockIndex;
16 enum class SynchronizationState;
17 struct bilingual_str;
18 
19 namespace node {
20 
21 static constexpr int DEFAULT_STOPATHEIGHT{0};
22 
24 {
25 public:
27 
28  [[nodiscard]] kernel::InterruptResult blockTip(SynchronizationState state, CBlockIndex& index) override;
29 
30  void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override;
31 
32  void progress(const bilingual_str& title, int progress_percent, bool resume_possible) override;
33 
34  void warning(const bilingual_str& warning) override;
35 
36  void flushError(const std::string& debug_message) override;
37 
38  void fatalError(const std::string& debug_message, const bilingual_str& user_message = {}) override;
39 
44 private:
45  std::atomic<int>& m_exit_status;
46 };
47 
48 void ReadNotificationArgs(const ArgsManager& args, KernelNotifications& notifications);
49 
50 } // namespace node
51 
52 #endif // BITCOIN_NODE_KERNEL_NOTIFICATIONS_H
int exit_status
ArgsManager & args
Definition: bitcoind.cpp:269
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:159
A base class defining functions for notifying about certain kernel events.
int m_stop_at_height
Block height after which blockTip notification will return Interrupted{}, if >0.
void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override
std::atomic< int > & m_exit_status
void progress(const bilingual_str &title, int progress_percent, bool resume_possible) override
void flushError(const std::string &debug_message) override
The flush error notification is sent to notify the user that an error occurred while flushing block d...
void warning(const bilingual_str &warning) override
void fatalError(const std::string &debug_message, const bilingual_str &user_message={}) override
The fatal error notification is sent to notify the user when an error occurs in kernel code that can'...
kernel::InterruptResult blockTip(SynchronizationState state, CBlockIndex &index) override
KernelNotifications(std::atomic< int > &exit_status)
bool m_shutdown_on_fatal_error
Useful for tests, can be set to false to avoid shutdown on fatal error.
std::variant< std::monostate, Interrupted > InterruptResult
Simple result type for functions that need to propagate an interrupt status and don't have other retu...
Definition: init.h:25
void ReadNotificationArgs(const ArgsManager &args, KernelNotifications &notifications)
static constexpr int DEFAULT_STOPATHEIGHT
Bilingual messages:
Definition: translation.h:18
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:86