#include <bitcoinkernel.h>

Data Fields
void *	user_data

btck_DestroyCallback	user_data_destroy
	Frees the provided user data structure.

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

btck_NotifyHeaderTip	header_tip
	A new best block header was added.

btck_NotifyProgress	progress
	Reports on current block synchronization progress.

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

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

btck_NotifyFlushError	flush_error
	An error encountered when flushing data to disk.

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

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. Note that this makes it 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.

Field Documentation

◆ block_tip

btck_NotifyBlockTip btck_NotificationInterfaceCallbacks::block_tip

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

◆ fatal_error

btck_NotifyFatalError btck_NotificationInterfaceCallbacks::fatal_error

A un-recoverable system error encountered by the library.

◆ flush_error

btck_NotifyFlushError btck_NotificationInterfaceCallbacks::flush_error

An error encountered when flushing data to disk.

◆ header_tip

btck_NotifyHeaderTip btck_NotificationInterfaceCallbacks::header_tip

A new best block header was added.

◆ progress

btck_NotifyProgress btck_NotificationInterfaceCallbacks::progress

Reports on current block synchronization progress.

◆ 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.

◆ user_data_destroy

btck_DestroyCallback btck_NotificationInterfaceCallbacks::user_data_destroy

Frees the provided user data structure.

◆ warning_set

btck_NotifyWarningSet btck_NotificationInterfaceCallbacks::warning_set

A warning issued by the kernel library during validation.

◆ warning_unset

btck_NotifyWarningUnset btck_NotificationInterfaceCallbacks::warning_unset

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

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

bitcoinkernel.h

Data Fields