Bitcoin Core  0.15.99
P2P Digital Currency
Public Member Functions | Private Attributes | Friends | List of all members
CChain Class Reference

An in-memory indexed chain of blocks. More...

#include <chain.h>

Public Member Functions

CBlockIndexGenesis () const
 Returns the index entry for the genesis block of this chain, or nullptr if none. More...
 
CBlockIndexTip () const
 Returns the index entry for the tip of this chain, or nullptr if none. More...
 
CBlockIndexoperator[] (int nHeight) const
 Returns the index entry at a particular height in this chain, or nullptr if no such height exists. More...
 
bool Contains (const CBlockIndex *pindex) const
 Efficiently check whether a block is present in this chain. More...
 
CBlockIndexNext (const CBlockIndex *pindex) const
 Find the successor of a block in this chain, or nullptr if the given index is not found or is the tip. More...
 
int Height () const
 Return the maximal height in the chain. More...
 
void SetTip (CBlockIndex *pindex)
 Set/initialize a chain with a given tip. More...
 
CBlockLocator GetLocator (const CBlockIndex *pindex=nullptr) const
 Return a CBlockLocator that refers to a block in this chain (by default the tip). More...
 
const CBlockIndexFindFork (const CBlockIndex *pindex) const
 Find the last common block between this chain and a block index entry. More...
 
CBlockIndexFindEarliestAtLeast (int64_t nTime) const
 Find the earliest block with timestamp equal or greater than the given. More...
 

Private Attributes

std::vector< CBlockIndex * > vChain
 

Friends

bool operator== (const CChain &a, const CChain &b)
 Compare two chains efficiently. More...
 

Detailed Description

An in-memory indexed chain of blocks.

Definition at line 435 of file chain.h.

Member Function Documentation

bool CChain::Contains ( const CBlockIndex pindex) const
inline

Efficiently check whether a block is present in this chain.

Definition at line 464 of file chain.h.

Here is the caller graph for this function:

CBlockIndex * CChain::FindEarliestAtLeast ( int64_t  nTime) const

Find the earliest block with timestamp equal or greater than the given.

Definition at line 62 of file chain.cpp.

Here is the caller graph for this function:

const CBlockIndex * CChain::FindFork ( const CBlockIndex pindex) const

Find the last common block between this chain and a block index entry.

Definition at line 51 of file chain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

CBlockIndex* CChain::Genesis ( ) const
inline

Returns the index entry for the genesis block of this chain, or nullptr if none.

Definition at line 441 of file chain.h.

Here is the caller graph for this function:

CBlockLocator CChain::GetLocator ( const CBlockIndex pindex = nullptr) const

Return a CBlockLocator that refers to a block in this chain (by default the tip).

Definition at line 23 of file chain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

int CChain::Height ( ) const
inline

Return the maximal height in the chain.

Is equal to chain.Tip() ? chain.Tip()->nHeight : -1.

Definition at line 477 of file chain.h.

Here is the caller graph for this function:

CBlockIndex* CChain::Next ( const CBlockIndex pindex) const
inline

Find the successor of a block in this chain, or nullptr if the given index is not found or is the tip.

Definition at line 469 of file chain.h.

Here is the caller graph for this function:

CBlockIndex* CChain::operator[] ( int  nHeight) const
inline

Returns the index entry at a particular height in this chain, or nullptr if no such height exists.

Definition at line 451 of file chain.h.

void CChain::SetTip ( CBlockIndex pindex)

Set/initialize a chain with a given tip.

CChain implementation.

Definition at line 11 of file chain.cpp.

Here is the caller graph for this function:

CBlockIndex* CChain::Tip ( ) const
inline

Returns the index entry for the tip of this chain, or nullptr if none.

Definition at line 446 of file chain.h.

Friends And Related Function Documentation

bool operator== ( const CChain a,
const CChain b 
)
friend

Compare two chains efficiently.

Definition at line 458 of file chain.h.

Member Data Documentation

std::vector<CBlockIndex*> CChain::vChain
private

Definition at line 437 of file chain.h.


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