A struct for holding the kernel notification callbacks. More...

#include <bitcoinkernel.h>

Collaboration diagram for btck_NotificationInterfaceCallbacks:

Public Attributes
void *	user_data
	Holds a user-defined opaque structure that is passed to the notification callbacks. More...

btck_DestroyCallback	user_data_destroy
	Frees the provided user data structure. More...

btck_NotifyBlockTip	block_tip
	The chain's tip was updated to the provided block entry. More...

btck_NotifyHeaderTip	header_tip
	A new best block header was added. More...

btck_NotifyProgress	progress
	Reports on current block synchronization progress. More...

btck_NotifyWarningSet	warning_set
	A warning issued by the kernel library during validation. More...

btck_NotifyWarningUnset	warning_unset
	A previous condition leading to the issuance of a warning is no longer given. More...

btck_NotifyFlushError	flush_error
	An error encountered when flushing data to disk. More...

btck_NotifyFatalError	fatal_error
	A un-recoverable system error encountered by the library. More...

Detailed Description

A struct for holding the kernel notification callbacks.

The user data pointer may be used to point to user-defined structures to make processing the notifications easier.

If user_data_destroy is provided, the kernel will automatically call this callback to clean up user_data when the notification interface object is destroyed. If user_data_destroy is NULL, it is the user's responsibility to ensure that the user_data outlives the kernel objects. Notifications can occur even as kernel objects are deleted, so care has to be taken to ensure safe unwinding.

Definition at line 378 of file bitcoinkernel.h.

Member Data Documentation

◆ block_tip

btck_NotifyBlockTip btck_NotificationInterfaceCallbacks::block_tip

The chain's tip was updated to the provided block entry.

Definition at line 383 of file bitcoinkernel.h.

◆ fatal_error

btck_NotifyFatalError btck_NotificationInterfaceCallbacks::fatal_error

A un-recoverable system error encountered by the library.

Definition at line 389 of file bitcoinkernel.h.

◆ flush_error

btck_NotifyFlushError btck_NotificationInterfaceCallbacks::flush_error

An error encountered when flushing data to disk.

Definition at line 388 of file bitcoinkernel.h.

◆ header_tip

btck_NotifyHeaderTip btck_NotificationInterfaceCallbacks::header_tip

A new best block header was added.

Definition at line 384 of file bitcoinkernel.h.

◆ progress

btck_NotifyProgress btck_NotificationInterfaceCallbacks::progress

Reports on current block synchronization progress.

Definition at line 385 of file bitcoinkernel.h.

◆ user_data

void* btck_NotificationInterfaceCallbacks::user_data

Holds a user-defined opaque structure that is passed to the notification callbacks.

If user_data_destroy is also defined ownership of the user_data is passed to the created context options and subsequently context.

Definition at line 379 of file bitcoinkernel.h.

◆ user_data_destroy

btck_DestroyCallback btck_NotificationInterfaceCallbacks::user_data_destroy

Frees the provided user data structure.

Definition at line 382 of file bitcoinkernel.h.

◆ warning_set

btck_NotifyWarningSet btck_NotificationInterfaceCallbacks::warning_set

A warning issued by the kernel library during validation.

Definition at line 386 of file bitcoinkernel.h.

◆ warning_unset

btck_NotifyWarningUnset btck_NotificationInterfaceCallbacks::warning_unset

A previous condition leading to the issuance of a warning is no longer given.

Definition at line 387 of file bitcoinkernel.h.

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

src/kernel/bitcoinkernel.h

Public Attributes