interfaces::FoundBlock Class Reference

Helper for findBlock to selectively return pieces of block data. More...

#include <chain.h>

Collaboration diagram for interfaces::FoundBlock:

Public Member Functions
FoundBlock &	hash (BlockHash &hash)
FoundBlock &	height (int &height)
FoundBlock &	time (int64_t &time)
FoundBlock &	maxTime (int64_t &max_time)
FoundBlock &	mtpTime (int64_t &mtp_time)
FoundBlock &	inActiveChain (bool &in_active_chain)
	Return whether block is in the active (most-work) chain. More...
FoundBlock &	locator (CBlockLocator &locator)
	Return locator if block is in the active chain. More...
FoundBlock &	nextBlock (const FoundBlock &next_block)
	Return next block in the active chain if current block is in the active chain. More...
FoundBlock &	data (CBlock &data)
	Read block data from disk. More...

Public Attributes
BlockHash *	m_hash = nullptr
int *	m_height = nullptr
int64_t *	m_time = nullptr
int64_t *	m_max_time = nullptr
int64_t *	m_mtp_time = nullptr
bool *	m_in_active_chain = nullptr
CBlockLocator *	m_locator = nullptr
const FoundBlock *	m_next_block = nullptr
CBlock *	m_data = nullptr

Detailed Description

Helper for findBlock to selectively return pieces of block data.

Definition at line 55 of file chain.h.

Member Function Documentation

data()

FoundBlock & interfaces::FoundBlock::data ( CBlock &  data )

inline

Read block data from disk.

If the block exists but doesn't have data (for example due to pruning), the CBlock variable will be set to null.

Definition at line 95 of file chain.h.

Here is the call graph for this function:

Here is the caller graph for this function:

hash()

FoundBlock & interfaces::FoundBlock::hash ( BlockHash &  hash )

inline

Definition at line 57 of file chain.h.

Here is the call graph for this function:

Here is the caller graph for this function:

height()

FoundBlock & interfaces::FoundBlock::height ( int &  height )

inline

Definition at line 61 of file chain.h.

Here is the call graph for this function:

Here is the caller graph for this function:

inActiveChain()

FoundBlock & interfaces::FoundBlock::inActiveChain ( bool &  in_active_chain )

inline

Return whether block is in the active (most-work) chain.

Definition at line 78 of file chain.h.

locator()

FoundBlock & interfaces::FoundBlock::locator ( CBlockLocator &  locator )

inline

Return locator if block is in the active chain.

Definition at line 83 of file chain.h.

Here is the call graph for this function:

Here is the caller graph for this function:

maxTime()

FoundBlock & interfaces::FoundBlock::maxTime ( int64_t &  max_time )

inline

Definition at line 69 of file chain.h.

mtpTime()

FoundBlock & interfaces::FoundBlock::mtpTime ( int64_t &  mtp_time )

inline

Definition at line 73 of file chain.h.

nextBlock()

FoundBlock & interfaces::FoundBlock::nextBlock ( const FoundBlock &  next_block )

inline

Return next block in the active chain if current block is in the active chain.

Definition at line 89 of file chain.h.

time()

FoundBlock & interfaces::FoundBlock::time ( int64_t &  time )

inline

Definition at line 65 of file chain.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_data

CBlock* interfaces::FoundBlock::m_data = nullptr

Definition at line 108 of file chain.h.

m_hash

BlockHash* interfaces::FoundBlock::m_hash = nullptr

Definition at line 100 of file chain.h.

m_height

int* interfaces::FoundBlock::m_height = nullptr

Definition at line 101 of file chain.h.

m_in_active_chain

bool* interfaces::FoundBlock::m_in_active_chain = nullptr

Definition at line 105 of file chain.h.

m_locator

CBlockLocator* interfaces::FoundBlock::m_locator = nullptr

Definition at line 106 of file chain.h.

m_max_time

int64_t* interfaces::FoundBlock::m_max_time = nullptr

Definition at line 103 of file chain.h.

m_mtp_time

int64_t* interfaces::FoundBlock::m_mtp_time = nullptr

Definition at line 104 of file chain.h.

m_next_block

const FoundBlock* interfaces::FoundBlock::m_next_block = nullptr

Definition at line 107 of file chain.h.

m_time

int64_t* interfaces::FoundBlock::m_time = nullptr

Definition at line 102 of file chain.h.

---

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

• /work/src/interfaces/chain.h