#include <kernel_notifications.h>

Inheritance diagram for node::KernelNotifications:

Collaboration diagram for node::KernelNotifications:

Public Member Functions
	KernelNotifications (const std::function< bool()> &shutdown_request, std::atomic< int > &exit_status, node::Warnings &warnings)

kernel::InterruptResult	blockTip (SynchronizationState state, CBlockIndex &index) override EXCLUSIVE_LOCKS_REQUIRED(!m_tip_block_mutex)

void	headerTip (SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override

void	progress (const bilingual_str &title, int progress_percent, bool resume_possible) override

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

void	warningUnset (kernel::Warning id) override

void	flushError (const bilingual_str &message) override
	The flush error notification is sent to notify the user that an error occurred while flushing block data to disk. More...

void	fatalError (const bilingual_str &message) override
	The fatal error notification is sent to notify the user when an error occurs in kernel code that can't be recovered from. More...

std::condition_variable m_tip_block_cv	GUARDED_BY (m_tip_block_mutex)

uint256 m_tip_block	GUARDED_BY (m_tip_block_mutex)
	The block for which the last blockTip notification was received. More...

Public Member Functions inherited from kernel::Notifications
virtual	~Notifications ()=default

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	warningSet (Warning id, const bilingual_str &message)

virtual void	warningUnset (Warning id)

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

Public Attributes
int	m_stop_at_height {DEFAULT_STOPATHEIGHT}
	Block height after which blockTip notification will return Interrupted{}, if >0. More...

bool	m_shutdown_on_fatal_error {true}
	Useful for tests, can be set to false to avoid shutdown on fatal error. More...

Mutex	m_tip_block_mutex

Private Attributes
const std::function< bool()> &	m_shutdown_request

std::atomic< int > &	m_exit_status

node::Warnings &	m_warnings

Detailed Description

Definition at line 32 of file kernel_notifications.h.

Constructor & Destructor Documentation

◆ KernelNotifications()

node::KernelNotifications::KernelNotifications	(	const std::function< bool()> &	shutdown_request,
		std::atomic< int > &	exit_status,
		node::Warnings &	warnings
	)

inline

Definition at line 35 of file kernel_notifications.h.

Member Function Documentation

◆ blockTip()

kernel::InterruptResult node::KernelNotifications::blockTip	(	SynchronizationState	state,
		CBlockIndex &	index
	)

overridevirtual

Reimplemented from kernel::Notifications.

Definition at line 51 of file kernel_notifications.cpp.

Here is the call graph for this function:

◆ fatalError()

void node::KernelNotifications::fatalError ( const bilingual_str & message )

overridevirtual

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 from kernel::Notifications.

Definition at line 96 of file kernel_notifications.cpp.

Here is the call graph for this function:

◆ flushError()

void node::KernelNotifications::flushError ( const bilingual_str & message )

overridevirtual

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 from kernel::Notifications.

Definition at line 91 of file kernel_notifications.cpp.

Here is the call graph for this function:

◆ GUARDED_BY() [1/2]

std::condition_variable m_tip_block_cv node::KernelNotifications::GUARDED_BY ( m_tip_block_mutex )

◆ GUARDED_BY() [2/2]

uint256 m_tip_block node::KernelNotifications::GUARDED_BY ( m_tip_block_mutex )

inline

The block for which the last blockTip notification was received.

It's first set when the tip is connected during node initialization. Might be unset during an early shutdown.

Definition at line 62 of file kernel_notifications.h.

◆ headerTip()

void node::KernelNotifications::headerTip	(	SynchronizationState	state,
		int64_t	height,
		int64_t	timestamp,
		bool	presync
	)

overridevirtual

Reimplemented from kernel::Notifications.

Definition at line 69 of file kernel_notifications.cpp.

◆ progress()

void node::KernelNotifications::progress	(	const bilingual_str &	title,
		int	progress_percent,
		bool	resume_possible
	)

overridevirtual

Reimplemented from kernel::Notifications.

Definition at line 74 of file kernel_notifications.cpp.

◆ warningSet()

void node::KernelNotifications::warningSet	(	kernel::Warning	id,
		const bilingual_str &	message
	)

overridevirtual

Reimplemented from kernel::Notifications.

Definition at line 79 of file kernel_notifications.cpp.

Here is the call graph for this function:

◆ warningUnset()

void node::KernelNotifications::warningUnset ( kernel::Warning id )

overridevirtual

Reimplemented from kernel::Notifications.

Definition at line 86 of file kernel_notifications.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ m_exit_status

std::atomic<int>& node::KernelNotifications::m_exit_status

private

Definition at line 66 of file kernel_notifications.h.

◆ m_shutdown_on_fatal_error

bool node::KernelNotifications::m_shutdown_on_fatal_error {true}

Useful for tests, can be set to false to avoid shutdown on fatal error.

Definition at line 55 of file kernel_notifications.h.

◆ m_shutdown_request

const std::function<bool()>& node::KernelNotifications::m_shutdown_request

private

Definition at line 65 of file kernel_notifications.h.

◆ m_stop_at_height

int node::KernelNotifications::m_stop_at_height {DEFAULT_STOPATHEIGHT}

Block height after which blockTip notification will return Interrupted{}, if >0.

Definition at line 53 of file kernel_notifications.h.

◆ m_tip_block_mutex

Mutex node::KernelNotifications::m_tip_block_mutex

Definition at line 57 of file kernel_notifications.h.

◆ m_warnings

node::Warnings& node::KernelNotifications::m_warnings

private

Definition at line 67 of file kernel_notifications.h.

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

src/node/kernel_notifications.h
src/node/kernel_notifications.cpp

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KernelNotifications()

Member Function Documentation

◆ blockTip()

◆ fatalError()

◆ flushError()

◆ GUARDED_BY() [1/2]

◆ GUARDED_BY() [2/2]

◆ headerTip()

◆ progress()

◆ warningSet()

◆ warningUnset()

Member Data Documentation

◆ m_exit_status

◆ m_shutdown_on_fatal_error

◆ m_shutdown_request

◆ m_stop_at_height

◆ m_tip_block_mutex

◆ m_warnings