notifications_interface.h

Go to the documentation of this file.

// Copyright (c) 2023-present 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 <cstdint>
#include <variant>
 
class CBlockIndex;
enum class SynchronizationState;
struct bilingual_str;
 
namespace kernel {

struct Interrupted{};
enum class Warning;
 

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() = default;
 
    [[nodiscard]] virtual InterruptResult blockTip(SynchronizationState state, const CBlockIndex& index, double verification_progress) { 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 warningSet(Warning id, const bilingual_str& message) {}
    virtual void warningUnset(Warning id) {}

    virtual void flushError(const bilingual_str& message) {}

    virtual void fatalError(const bilingual_str& message) {}
};
} // namespace kernel
 
#endif // BITCOIN_KERNEL_NOTIFICATIONS_INTERFACE_H