BaseIndex::DB Class Reference

The database stores a block locator of the chain the database is synced to so that the index can efficiently determine the point it last stopped at. More...

#include <base.h>

Inheritance diagram for BaseIndex::DB:

Collaboration diagram for BaseIndex::DB:

Public Member Functions
	DB (const fs::path &path, size_t n_cache_size, bool f_memory=false, bool f_wipe=false, bool f_obfuscate=false)
bool	ReadBestBlock (CBlockLocator &locator) const
	Read block locator of the chain that the index is in sync with. More...
void	WriteBestBlock (CDBBatch &batch, const CBlockLocator &locator)
	Write block locator of the chain that the index is in sync with. More...
Public Member Functions inherited from CDBWrapper
	CDBWrapper (const DBParams &params)
	~CDBWrapper ()
	CDBWrapper (const CDBWrapper &)=delete
CDBWrapper &	operator= (const CDBWrapper &)=delete
template<typename K , typename V >
bool	Read (const K &key, V &value) const
template<typename K , typename V >
bool	Write (const K &key, const V &value, bool fSync=false)
std::optional< fs::path >	StoragePath ()
template<typename K >
bool	Exists (const K &key) const
template<typename K >
bool	Erase (const K &key, bool fSync=false)
bool	WriteBatch (CDBBatch &batch, bool fSync=false)
size_t	DynamicMemoryUsage () const
CDBIterator *	NewIterator ()
bool	IsEmpty ()
	Return true if the database managed by this class contains no entries. More...
template<typename K >
size_t	EstimateSize (const K &key_begin, const K &key_end) const

Detailed Description

The database stores a block locator of the chain the database is synced to so that the index can efficiently determine the point it last stopped at.

A locator is used instead of a simple hash of the chain tip because blocks and block index entries may not be flushed to disk until after this database is updated.

Definition at line 52 of file base.h.

Constructor & Destructor Documentation

DB()

BaseIndex::DB::DB	(	const fs::path &	path,
		size_t	n_cache_size,
		bool	f_memory = false,
		bool	f_wipe = false,
		bool	f_obfuscate = false
	)

Definition at line 46 of file base.cpp.

Here is the call graph for this function:

Member Function Documentation

ReadBestBlock()

bool BaseIndex::DB::ReadBestBlock

(

CBlockLocator &

locator

)

const

Read block locator of the chain that the index is in sync with.

Definition at line 56 of file base.cpp.

Here is the call graph for this function:

WriteBestBlock()

void BaseIndex::DB::WriteBestBlock	(	CDBBatch &	batch,
		const CBlockLocator &	locator
	)

Write block locator of the chain that the index is in sync with.

Definition at line 65 of file base.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/index/base.h
• src/index/base.cpp