CDBWrapper Class Reference

#include <dbwrapper.h>

Inheritance diagram for CDBWrapper:

Collaboration diagram for CDBWrapper:

Public Member Functions
	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.
template<typename K >
size_t	EstimateSize (const K &key_begin, const K &key_end) const
template<typename K >
void	CompactRange (const K &key_begin, const K &key_end) const
	Compact a certain range of keys in the database.

Private Member Functions
std::vector< uint8_t >	CreateObfuscateKey () const
	Returns a string (consisting of 8 random bytes) suitable for use as an obfuscating XOR key.

Private Attributes
leveldb::Env *	penv
	custom environment this database is using (may be nullptr in case of default environment)
leveldb::Options	options
	database options used
leveldb::ReadOptions	readoptions
	options used when reading from the database
leveldb::ReadOptions	iteroptions
	options used when iterating over values of the database
leveldb::WriteOptions	writeoptions
	options used when writing to the database
leveldb::WriteOptions	syncoptions
	options used when sync writing to the database
leveldb::DB *	pdb
	the database itself
std::string	m_name
	the name of this database
std::vector< uint8_t >	obfuscate_key
	a key used for optional XOR-obfuscation of the database
const fs::path	m_path
	path to filesystem storage
bool	m_is_memory
	whether or not the database resides in memory

Static Private Attributes
static const std::string	OBFUSCATE_KEY_KEY
	the key under which the obfuscation key is stored
static const unsigned int	OBFUSCATE_KEY_NUM_BYTES = 8
	the length of the obfuscate key in number of bytes

Friends
const std::vector< uint8_t > &	dbwrapper_private::GetObfuscateKey (const CDBWrapper &w)

Detailed Description

Definition at line 200 of file dbwrapper.h.

Constructor & Destructor Documentation

CDBWrapper() [1/2]

CDBWrapper::CDBWrapper

(

const DBParams &

params

)

Definition at line 121 of file dbwrapper.cpp.

Here is the call graph for this function:

~CDBWrapper()

CDBWrapper::~CDBWrapper

(

)

Definition at line 183 of file dbwrapper.cpp.

CDBWrapper() [2/2]

CDBWrapper::CDBWrapper ( const CDBWrapper &  )

delete

Member Function Documentation

CompactRange()

template<typename K >

void CDBWrapper::CompactRange ( const K &  key_begin, const K &  key_end  ) const

inline

Compact a certain range of keys in the database.

Definition at line 349 of file dbwrapper.h.

Here is the call graph for this function:

CreateObfuscateKey()

std::vector< uint8_t > CDBWrapper::CreateObfuscateKey ( ) const

private

Returns a string (consisting of 8 random bytes) suitable for use as an obfuscating XOR key.

Definition at line 238 of file dbwrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

DynamicMemoryUsage()

size_t CDBWrapper::DynamicMemoryUsage

(

)

const

Definition at line 216 of file dbwrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Erase()

template<typename K >

bool CDBWrapper::Erase ( const K &  key, bool  fSync = false  )

inline

Definition at line 309 of file dbwrapper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

EstimateSize()

template<typename K >

size_t CDBWrapper::EstimateSize ( const K &  key_begin, const K &  key_end  ) const

inline

Definition at line 330 of file dbwrapper.h.

Here is the call graph for this function:

Exists()

template<typename K >

bool CDBWrapper::Exists ( const K &  key ) const

inline

Definition at line 293 of file dbwrapper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

IsEmpty()

bool CDBWrapper::IsEmpty

(

)

Return true if the database managed by this class contains no entries.

Definition at line 244 of file dbwrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

NewIterator()

CDBIterator * CDBWrapper::NewIterator ( )

inline

Definition at line 320 of file dbwrapper.h.

Here is the caller graph for this function:

operator=()

CDBWrapper & CDBWrapper::operator= ( const CDBWrapper &  )

delete

Read()

template<typename K , typename V >

bool CDBWrapper::Read ( const K &  key, V &  value  ) const

inline

Definition at line 254 of file dbwrapper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

StoragePath()

std::optional< fs::path > CDBWrapper::StoragePath ( )

inline

Returns

filesystem path to the on-disk data.

Definition at line 286 of file dbwrapper.h.

Write()

template<typename K , typename V >

bool CDBWrapper::Write ( const K &  key, const V &  value, bool  fSync = false  )

inline

Definition at line 279 of file dbwrapper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

WriteBatch()

bool CDBWrapper::WriteBatch	(	CDBBatch &	batch,
		bool	fSync = false
	)

Definition at line 196 of file dbwrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

dbwrapper_private::GetObfuscateKey

const std::vector< uint8_t > & dbwrapper_private::GetObfuscateKey ( const CDBWrapper &  w )

friend

Member Data Documentation

iteroptions

leveldb::ReadOptions CDBWrapper::iteroptions

private

options used when iterating over values of the database

Definition at line 216 of file dbwrapper.h.

m_is_memory

bool CDBWrapper::m_is_memory

private

whether or not the database resides in memory

Definition at line 245 of file dbwrapper.h.

m_name

std::string CDBWrapper::m_name

private

the name of this database

Definition at line 228 of file dbwrapper.h.

m_path

const fs::path CDBWrapper::m_path

private

path to filesystem storage

Definition at line 242 of file dbwrapper.h.

obfuscate_key

std::vector<uint8_t> CDBWrapper::obfuscate_key

private

a key used for optional XOR-obfuscation of the database

Definition at line 231 of file dbwrapper.h.

OBFUSCATE_KEY_KEY

const std::string CDBWrapper::OBFUSCATE_KEY_KEY

staticprivate

the key under which the obfuscation key is stored

Definition at line 234 of file dbwrapper.h.

OBFUSCATE_KEY_NUM_BYTES

const unsigned int CDBWrapper::OBFUSCATE_KEY_NUM_BYTES = 8

staticprivate

the length of the obfuscate key in number of bytes

Definition at line 237 of file dbwrapper.h.

options

leveldb::Options CDBWrapper::options

private

database options used

Definition at line 210 of file dbwrapper.h.

pdb

leveldb::DB* CDBWrapper::pdb

private

the database itself

Definition at line 225 of file dbwrapper.h.

penv

leveldb::Env* CDBWrapper::penv

private

custom environment this database is using (may be nullptr in case of default environment)

Definition at line 207 of file dbwrapper.h.

readoptions

leveldb::ReadOptions CDBWrapper::readoptions

private

options used when reading from the database

Definition at line 213 of file dbwrapper.h.

syncoptions

leveldb::WriteOptions CDBWrapper::syncoptions

private

options used when sync writing to the database

Definition at line 222 of file dbwrapper.h.

writeoptions

leveldb::WriteOptions CDBWrapper::writeoptions

private

options used when writing to the database

Definition at line 219 of file dbwrapper.h.

---

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

• src/dbwrapper.h
• src/dbwrapper.cpp