Bitcoin Core  27.99.0
P2P Digital Currency
Public Member Functions | Protected Attributes | List of all members
CCoinsViewDB Class Referencefinal

CCoinsView backed by the coin database (chainstate/) More...

#include <txdb.h>

Inheritance diagram for CCoinsViewDB:
[legend]
Collaboration diagram for CCoinsViewDB:
[legend]

Public Member Functions

 CCoinsViewDB (DBParams db_params, CoinsViewOptions options)
 
bool GetCoin (const COutPoint &outpoint, Coin &coin) const override
 Retrieve the Coin (unspent transaction output) for a given outpoint. More...
 
bool HaveCoin (const COutPoint &outpoint) const override
 Just check whether a given outpoint is unspent. More...
 
uint256 GetBestBlock () const override
 Retrieve the block hash whose state this CCoinsView currently represents. More...
 
std::vector< uint256GetHeadBlocks () const override
 Retrieve the range of blocks that may have been only partially written. More...
 
bool BatchWrite (CCoinsMap &mapCoins, const uint256 &hashBlock, bool erase=true) override
 Do a bulk modification (multiple Coin changes + BestBlock change). More...
 
std::unique_ptr< CCoinsViewCursorCursor () const override
 Get a cursor to iterate over the whole state. More...
 
bool NeedsUpgrade ()
 Whether an unsupported database format is used. More...
 
size_t EstimateSize () const override
 Estimate database size (0 if not implemented) More...
 
void ResizeCache (size_t new_cache_size) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
 Dynamically alter the underlying leveldb cache size. More...
 
std::optional< fs::pathStoragePath ()
 
- Public Member Functions inherited from CCoinsView
virtual ~CCoinsView ()
 As we use CCoinsViews polymorphically, have a virtual destructor. More...
 

Protected Attributes

DBParams m_db_params
 
CoinsViewOptions m_options
 
std::unique_ptr< CDBWrapperm_db
 

Detailed Description

CCoinsView backed by the coin database (chainstate/)

Definition at line 53 of file txdb.h.

Constructor & Destructor Documentation

◆ CCoinsViewDB()

CCoinsViewDB::CCoinsViewDB ( DBParams  db_params,
CoinsViewOptions  options 
)
explicit

Definition at line 49 of file txdb.cpp.

Member Function Documentation

◆ BatchWrite()

bool CCoinsViewDB::BatchWrite ( CCoinsMap mapCoins,
const uint256 hashBlock,
bool  erase = true 
)
overridevirtual

Do a bulk modification (multiple Coin changes + BestBlock change).

The passed mapCoins can be modified.

Reimplemented from CCoinsView.

Definition at line 91 of file txdb.cpp.

Here is the call graph for this function:

◆ Cursor()

std::unique_ptr< CCoinsViewCursor > CCoinsViewDB::Cursor ( ) const
overridevirtual

Get a cursor to iterate over the whole state.

Reimplemented from CCoinsView.

Definition at line 180 of file txdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EstimateSize()

size_t CCoinsViewDB::EstimateSize ( ) const
overridevirtual

Estimate database size (0 if not implemented)

Reimplemented from CCoinsView.

Definition at line 152 of file txdb.cpp.

◆ GetBestBlock()

uint256 CCoinsViewDB::GetBestBlock ( ) const
overridevirtual

Retrieve the block hash whose state this CCoinsView currently represents.

Reimplemented from CCoinsView.

Definition at line 76 of file txdb.cpp.

Here is the caller graph for this function:

◆ GetCoin()

bool CCoinsViewDB::GetCoin ( const COutPoint outpoint,
Coin coin 
) const
overridevirtual

Retrieve the Coin (unspent transaction output) for a given outpoint.

Returns true only when an unspent coin was found, which is returned in coin. When false is returned, coin's value is unspecified.

Reimplemented from CCoinsView.

Definition at line 68 of file txdb.cpp.

◆ GetHeadBlocks()

std::vector< uint256 > CCoinsViewDB::GetHeadBlocks ( ) const
overridevirtual

Retrieve the range of blocks that may have been only partially written.

If the database is in a consistent state, the result is the empty vector. Otherwise, a two-element vector is returned consisting of the new and the old block hash, in that order.

Reimplemented from CCoinsView.

Definition at line 83 of file txdb.cpp.

Here is the caller graph for this function:

◆ HaveCoin()

bool CCoinsViewDB::HaveCoin ( const COutPoint outpoint) const
overridevirtual

Just check whether a given outpoint is unspent.

Reimplemented from CCoinsView.

Definition at line 72 of file txdb.cpp.

Here is the caller graph for this function:

◆ NeedsUpgrade()

bool CCoinsViewDB::NeedsUpgrade ( )

Whether an unsupported database format is used.

Definition at line 28 of file txdb.cpp.

◆ ResizeCache()

void CCoinsViewDB::ResizeCache ( size_t  new_cache_size)

Dynamically alter the underlying leveldb cache size.

Definition at line 54 of file txdb.cpp.

◆ StoragePath()

std::optional<fs::path> CCoinsViewDB::StoragePath ( )
inline
Returns
filesystem path to on-disk storage or std::nullopt if in memory.

Definition at line 77 of file txdb.h.

Here is the caller graph for this function:

Member Data Documentation

◆ m_db

std::unique_ptr<CDBWrapper> CCoinsViewDB::m_db
protected

Definition at line 58 of file txdb.h.

◆ m_db_params

DBParams CCoinsViewDB::m_db_params
protected

Definition at line 56 of file txdb.h.

◆ m_options

CoinsViewOptions CCoinsViewDB::m_options
protected

Definition at line 57 of file txdb.h.


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