#include <dbwrapper.h>

Inheritance diagram for CDBWrapper:

Collaboration diagram for CDBWrapper:

Public Member Functions
	CDBWrapper (const fs::path &path, size_t nCacheSize, bool fMemory=false, bool fWipe=false, bool obfuscate=false)

	~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

template<typename K >
void	CompactRange (const K &key_begin, const K &key_end) const
	Compact a certain range of keys in the database. More...

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. More...

Private Attributes
leveldb::Env *	penv
	custom environment this database is using (may be nullptr in case of default environment) More...

leveldb::Options	options
	database options used More...

leveldb::ReadOptions	readoptions
	options used when reading from the database More...

leveldb::ReadOptions	iteroptions
	options used when iterating over values of the database More...

leveldb::WriteOptions	writeoptions
	options used when writing to the database More...

leveldb::WriteOptions	syncoptions
	options used when sync writing to the database More...

leveldb::DB *	pdb
	the database itself More...

std::string	m_name
	the name of this database More...

std::vector< uint8_t >	obfuscate_key
	a key used for optional XOR-obfuscation of the database More...

const fs::path	m_path
	path to filesystem storage More...

bool	m_is_memory
	whether or not the database resides in memory More...

Static Private Attributes
static const std::string	OBFUSCATE_KEY_KEY
	the key under which the obfuscation key is stored More...

static const unsigned int	OBFUSCATE_KEY_NUM_BYTES = 8
	the length of the obfuscate key in number of bytes More...

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

Detailed Description

Definition at line 176 of file dbwrapper.h.

Constructor & Destructor Documentation

◆ CDBWrapper() [1/2]

CDBWrapper::CDBWrapper	(	const fs::path &	path,
		size_t	nCacheSize,
		bool	fMemory = `false`,
		bool	fWipe = `false`,
		bool	obfuscate = `false`
	)

Parameters

[in]	path	Location in the filesystem where leveldb data will be stored.
[in]	nCacheSize	Configures various leveldb cache settings.
[in]	fMemory	If true, use leveldb's memory environment.
[in]	fWipe	If true, remove all existing data.
[in]	obfuscate	If true, store data obfuscated via simple XOR. If false, XOR with a zero'd byte array.

Definition at line 119 of file dbwrapper.cpp.

Here is the call graph for this function:

◆ ~CDBWrapper()

CDBWrapper::~CDBWrapper ( )

Definition at line 182 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 336 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 236 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 214 of file dbwrapper.cpp.

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 296 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 317 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 280 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 242 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 307 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 241 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 273 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 266 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 195 of file dbwrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function 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 192 of file dbwrapper.h.

◆ m_is_memory

bool CDBWrapper::m_is_memory

private

whether or not the database resides in memory

Definition at line 221 of file dbwrapper.h.

◆ m_name

std::string CDBWrapper::m_name

private

the name of this database

Definition at line 204 of file dbwrapper.h.

◆ m_path

const fs::path CDBWrapper::m_path

private

path to filesystem storage

Definition at line 218 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 207 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 210 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 213 of file dbwrapper.h.

◆ options

leveldb::Options CDBWrapper::options

private

database options used

Definition at line 186 of file dbwrapper.h.

◆ pdb

leveldb::DB* CDBWrapper::pdb

private

the database itself

Definition at line 201 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 183 of file dbwrapper.h.

◆ readoptions

leveldb::ReadOptions CDBWrapper::readoptions

private

options used when reading from the database

Definition at line 189 of file dbwrapper.h.

◆ syncoptions

leveldb::WriteOptions CDBWrapper::syncoptions

private

options used when sync writing to the database

Definition at line 198 of file dbwrapper.h.

◆ writeoptions

leveldb::WriteOptions CDBWrapper::writeoptions

private

options used when writing to the database

Definition at line 195 of file dbwrapper.h.

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

/work/src/dbwrapper.h
/work/src/dbwrapper.cpp

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CDBWrapper() [1/2]

◆ ~CDBWrapper()

◆ CDBWrapper() [2/2]

Member Function Documentation

◆ CompactRange()

◆ CreateObfuscateKey()

◆ DynamicMemoryUsage()

◆ Erase()

◆ EstimateSize()

◆ Exists()

◆ IsEmpty()

◆ NewIterator()

◆ operator=()

◆ Read()

◆ StoragePath()

◆ Write()

◆ WriteBatch()

Friends And Related Function Documentation

◆ dbwrapper_private::GetObfuscateKey

Member Data Documentation

◆ iteroptions

◆ m_is_memory

◆ m_name

◆ m_path

◆ obfuscate_key

◆ OBFUSCATE_KEY_KEY

◆ OBFUSCATE_KEY_NUM_BYTES

◆ options

◆ pdb

◆ penv

◆ readoptions

◆ syncoptions

◆ writeoptions