Bitcoin Kernel
C header for interacting with the Bitcoin Kernel library.
Loading...
Searching...
No Matches
Data Fields
kernel_NotificationInterfaceCallbacks Struct Reference

#include <bitcoinkernel.h>

Data Fields

const void * user_data
 Holds a user-defined opaque structure that is passed to the notification callbacks.
 
kernel_NotifyBlockTip block_tip
 The chain's tip was updated to the provided block index.
 
kernel_NotifyHeaderTip header_tip
 A new best block header was added.
 
kernel_NotifyProgress progress
 Reports on current block synchronization progress.
 
kernel_NotifyWarningSet warning_set
 A warning issued by the kernel library during validation.
 
kernel_NotifyWarningUnset warning_unset
 A previous condition leading to the issuance of a warning is no longer given.
 
kernel_NotifyFlushError flush_error
 An error encountered when flushing data to disk.
 
kernel_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

kernel_NotifyBlockTip kernel_NotificationInterfaceCallbacks::block_tip

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

◆ fatal_error

kernel_NotifyFatalError kernel_NotificationInterfaceCallbacks::fatal_error

A un-recoverable system error encountered by the library.

◆ flush_error

kernel_NotifyFlushError kernel_NotificationInterfaceCallbacks::flush_error

An error encountered when flushing data to disk.

◆ header_tip

kernel_NotifyHeaderTip kernel_NotificationInterfaceCallbacks::header_tip

A new best block header was added.

◆ progress

kernel_NotifyProgress kernel_NotificationInterfaceCallbacks::progress

Reports on current block synchronization progress.

◆ user_data

const void* kernel_NotificationInterfaceCallbacks::user_data

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

◆ warning_set

kernel_NotifyWarningSet kernel_NotificationInterfaceCallbacks::warning_set

A warning issued by the kernel library during validation.

◆ warning_unset

kernel_NotifyWarningUnset kernel_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: