Notifications Class Reference

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

#include <notifications_interface.h>

Inheritance diagram for Notifications:

Public Member Functions
virtual	~Notifications ()=default
virtual InterruptResult	blockTip (SynchronizationState state, const CBlockIndex &index, double verification_progress)
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)

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 ( )

virtualdefault

Member Function Documentation

blockTip()

virtual InterruptResult kernel::Notifications::blockTip ( SynchronizationState state, const CBlockIndex & index, double verification_progress )

inlinenodiscardvirtual

Definition at line 40 of file notifications_interface.h.

fatalError()

virtual void kernel::Notifications::fatalError ( const bilingual_str & 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.

Definition at line 61 of file notifications_interface.h.

flushError()

virtual void kernel::Notifications::flushError ( const bilingual_str & 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.

Definition at line 52 of file notifications_interface.h.

headerTip()

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

inlinevirtual

Definition at line 41 of file notifications_interface.h.

progress()

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

inlinevirtual

Definition at line 42 of file notifications_interface.h.

warningSet()

virtual void kernel::Notifications::warningSet ( Warning id, const bilingual_str & message )

inlinevirtual

Definition at line 43 of file notifications_interface.h.

warningUnset()

virtual void kernel::Notifications::warningUnset ( Warning id )

inlinevirtual

Definition at line 44 of file notifications_interface.h.

---

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

• src/kernel/notifications_interface.h