notifications_interface.h

Go to the documentation of this file.

// Copyright (c) 2023 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_KERNEL_NOTIFICATIONS_INTERFACE_H
#define BITCOIN_KERNEL_NOTIFICATIONS_INTERFACE_H
 
#include <util/translation.h>
 
#include <cstdint>
#include <string>
#include <variant>
 
class CBlockIndex;
enum class SynchronizationState;
 
namespace kernel {
 
struct Interrupted {};
 
using InterruptResult = std::variant<std::monostate, Interrupted>;
 
template <typename T> bool IsInterrupted(const T &result) {
    return std::holds_alternative<kernel::Interrupted>(result);
}
 
class Notifications {
public:
    virtual ~Notifications(){};
 
    [[nodiscard]] virtual InterruptResult blockTip(SynchronizationState state,
                                                   CBlockIndex &index) {
        return {};
    }
    virtual void headerTip(SynchronizationState state, int64_t height,
                           int64_t timestamp, bool presync) {}
    virtual void progress(const bilingual_str &title, int progress_percent,
                          bool resume_possible) {}
    virtual void warning(const std::string &warning) {}
 
    virtual void flushError(const std::string &debug_message) {}
 
    virtual void fatalError(const std::string &debug_message,
                            const bilingual_str &user_message = {}) {}
};
} // namespace kernel
 
#endif // BITCOIN_KERNEL_NOTIFICATIONS_INTERFACE_H