Bitcoin Core  26.99.0
P2P Digital Currency
Public Member Functions | List of all members
kernel::Notifications Class Reference

A base class defining functions for notifying about certain kernel events. More...

#include <notifications_interface.h>

Inheritance diagram for kernel::Notifications:
[legend]

Public Member Functions

virtual ~Notifications ()
 
virtual InterruptResult blockTip (SynchronizationState state, CBlockIndex &index)
 
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 bilingual_str &warning)
 
virtual void flushError (const std::string &debug_message)
 The flush error notification is sent to notify the user that an error occurred while flushing block data to disk. More...
 
virtual void fatalError (const std::string &debug_message, const bilingual_str &user_message={})
 The fatal error notification is sent to notify the user when an error occurs in kernel code that can't be recovered from. More...
 

Detailed Description

A base class defining functions for notifying about certain kernel events.

Definition at line 35 of file notifications_interface.h.

Constructor & Destructor Documentation

◆ ~Notifications()

virtual kernel::Notifications::~Notifications ( )
inlinevirtual

Definition at line 38 of file notifications_interface.h.

Member Function Documentation

◆ blockTip()

virtual InterruptResult kernel::Notifications::blockTip ( SynchronizationState  state,
CBlockIndex index 
)
inlinevirtual

Reimplemented in node::KernelNotifications.

Definition at line 40 of file notifications_interface.h.

Here is the caller graph for this function:

◆ fatalError()

virtual void kernel::Notifications::fatalError ( const std::string &  debug_message,
const bilingual_str user_message = {} 
)
inlinevirtual

The fatal error notification is sent to notify the user when an error occurs in kernel code that can't be recovered from.

After this notification is sent, whatever function triggered the error should also return an error code or raise an exception. Applications can choose to handle the fatal error notification by logging the error, or notifying the user, or triggering an early shutdown as a precaution against causing more errors.

Reimplemented in node::KernelNotifications.

Definition at line 60 of file notifications_interface.h.

Here is the caller graph for this function:

◆ flushError()

virtual void kernel::Notifications::flushError ( const std::string &  debug_message)
inlinevirtual

The flush error notification is sent to notify the user that an error occurred while flushing block data to disk.

Kernel code may ignore flush errors that don't affect the immediate operation it is trying to perform. Applications can choose to handle the flush error notification by logging the error, or notifying the user, or triggering an early shutdown as a precaution against causing more errors.

Reimplemented in node::KernelNotifications.

Definition at line 51 of file notifications_interface.h.

Here is the caller graph for this function:

◆ headerTip()

virtual void kernel::Notifications::headerTip ( SynchronizationState  state,
int64_t  height,
int64_t  timestamp,
bool  presync 
)
inlinevirtual

Reimplemented in node::KernelNotifications.

Definition at line 41 of file notifications_interface.h.

Here is the caller graph for this function:

◆ progress()

virtual void kernel::Notifications::progress ( const bilingual_str title,
int  progress_percent,
bool  resume_possible 
)
inlinevirtual

Reimplemented in node::KernelNotifications.

Definition at line 42 of file notifications_interface.h.

Here is the caller graph for this function:

◆ warning()

virtual void kernel::Notifications::warning ( const bilingual_str warning)
inlinevirtual

Reimplemented in node::KernelNotifications.

Definition at line 43 of file notifications_interface.h.

Here is the caller graph for this function:

The documentation for this class was generated from the following file: