Inheritance diagram for ripple::NodeStore::NullBackend:

Collaboration diagram for ripple::NodeStore::NullBackend:

Public Member Functions
	NullBackend ()=default

	~NullBackend ()=default

std::string	getName () override
	Get the human-readable name of this backend.

void	open (bool createIfMissing) override
	Open the backend.

bool	isOpen () override
	Returns true is the database is open.

void	close () override
	Close the backend.

Status	fetch (void const , std::shared_ptr< NodeObject > ) override
	Fetch a single object.

std::pair< std::vector< std::shared_ptr< NodeObject > >, Status >	fetchBatch (std::vector< uint256 const * > const &hashes) override
	Fetch a batch synchronously.

void	store (std::shared_ptr< NodeObject > const &object) override
	Store a single object.

void	storeBatch (Batch const &batch) override
	Store a group of objects.

void	sync () override

void	for_each (std::function< void(std::shared_ptr< NodeObject >)> f) override
	Visit every object in the database This is usually called during import.

int	getWriteLoad () override
	Estimate the number of write operations pending.

void	setDeletePath () override
	Remove contents on disk upon destruction.

int	fdRequired () const override
	Returns the number of file descriptors the backend expects to need.

virtual std::optional< std::size_t >	getBlockSize () const
	Get the block size for backends that support it.

virtual void	open (bool createIfMissing, uint64_t appType, uint64_t uid, uint64_t salt)
	Open the backend.

virtual void	verify ()
	Perform consistency checks on database.

Detailed Description

Definition at line 9 of file NullFactory.cpp.

Constructor & Destructor Documentation

◆ NullBackend()

ripple::NodeStore::NullBackend::NullBackend ( )

default

◆ ~NullBackend()

ripple::NodeStore::NullBackend::~NullBackend ( )

default

Member Function Documentation

◆ getName()

std::string ripple::NodeStore::NullBackend::getName ( )

overridevirtual

Get the human-readable name of this backend.

This is used for diagnostic output.

Implements ripple::NodeStore::Backend.

Definition at line 17 of file NullFactory.cpp.

◆ open() [1/2]

void ripple::NodeStore::NullBackend::open ( bool createIfMissing )

overridevirtual

Open the backend.

Parameters

createIfMissing Create the database files if necessary. This allows the caller to catch exceptions.

Implements ripple::NodeStore::Backend.

Definition at line 23 of file NullFactory.cpp.

◆ isOpen()

bool ripple::NodeStore::NullBackend::isOpen ( )

overridevirtual

Returns true is the database is open.

Implements ripple::NodeStore::Backend.

Definition at line 28 of file NullFactory.cpp.

◆ close()

void ripple::NodeStore::NullBackend::close ( )

overridevirtual

Close the backend.

This allows the caller to catch exceptions.

Implements ripple::NodeStore::Backend.

Definition at line 34 of file NullFactory.cpp.

◆ fetch()

Status ripple::NodeStore::NullBackend::fetch	(	void const *	key,
		std::shared_ptr< NodeObject > *	pObject
	)

overridevirtual

Fetch a single object.

If the object is not found or an error is encountered, the result will indicate the condition.

Note: This will be called concurrently.

Parameters

key	A pointer to the key data.
pObject	[out] The created object if successful.

Returns: The result of the operation.

Implements ripple::NodeStore::Backend.

Definition at line 39 of file NullFactory.cpp.

◆ fetchBatch()

std::pair< std::vector< std::shared_ptr< NodeObject > >, Status > ripple::NodeStore::NullBackend::fetchBatch ( std::vector< uint256 const * > const & hashes )

overridevirtual

Fetch a batch synchronously.

Implements ripple::NodeStore::Backend.

Definition at line 45 of file NullFactory.cpp.

◆ store()

void ripple::NodeStore::NullBackend::store ( std::shared_ptr< NodeObject > const & object )

overridevirtual

Store a single object.

Depending on the implementation this may happen immediately or deferred using a scheduled task.

Note: This will be called concurrently.

Parameters

object The object to store.

Implements ripple::NodeStore::Backend.

Definition at line 51 of file NullFactory.cpp.

◆ storeBatch()

void ripple::NodeStore::NullBackend::storeBatch ( Batch const & batch )

overridevirtual

Store a group of objects.

Note: This function will not be called concurrently with itself or store.

Implements ripple::NodeStore::Backend.

Definition at line 56 of file NullFactory.cpp.

◆ sync()

void ripple::NodeStore::NullBackend::sync ( )

overridevirtual

Implements ripple::NodeStore::Backend.

Definition at line 61 of file NullFactory.cpp.

◆ for_each()

void ripple::NodeStore::NullBackend::for_each ( std::function< void(std::shared_ptr< NodeObject >)> f )

overridevirtual

Visit every object in the database This is usually called during import.

Note: This routine will not be called concurrently with itself or other methods.

See also: import

Implements ripple::NodeStore::Backend.

Definition at line 66 of file NullFactory.cpp.

◆ getWriteLoad()

int ripple::NodeStore::NullBackend::getWriteLoad ( )

overridevirtual

Estimate the number of write operations pending.

Implements ripple::NodeStore::Backend.

Definition at line 71 of file NullFactory.cpp.

◆ setDeletePath()

void ripple::NodeStore::NullBackend::setDeletePath ( )

overridevirtual

Remove contents on disk upon destruction.

Implements ripple::NodeStore::Backend.

Definition at line 77 of file NullFactory.cpp.

◆ fdRequired()

int ripple::NodeStore::NullBackend::fdRequired ( ) const

overridevirtual

Returns the number of file descriptors the backend expects to need.

Implements ripple::NodeStore::Backend.

Definition at line 83 of file NullFactory.cpp.

◆ getBlockSize()

virtual std::optional< std::size_t > ripple::NodeStore::Backend::getBlockSize ( ) const

virtualinherited

Get the block size for backends that support it.

Reimplemented in ripple::NodeStore::NuDBBackend.

Definition at line 40 of file Backend.h.

◆ open() [2/2]

virtual void ripple::NodeStore::Backend::open	(	bool	createIfMissing,
		uint64_t	appType,
		uint64_t	uid,
		uint64_t	salt
	)

virtualinherited

Open the backend.

Parameters

createIfMissing	Create the database files if necessary.
appType	Deterministic appType used to create a backend.
uid	Deterministic uid used to create a backend.
salt	Deterministic salt used to create a backend.

Exceptions

std::runtime_error is function is called not for NuDB backend.

Reimplemented in ripple::NodeStore::NuDBBackend.

Definition at line 65 of file Backend.h.

◆ verify()

virtual void ripple::NodeStore::Backend::verify ( )

virtualinherited

Perform consistency checks on database.

This method is implemented only by NuDBBackend. It is not yet called anywhere, but it might be a good idea to one day call it at startup to avert a crash.

Reimplemented in ripple::NodeStore::NuDBBackend.

Definition at line 136 of file Backend.h.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NullBackend()

◆ ~NullBackend()

Member Function Documentation

◆ getName()

◆ open() [1/2]

◆ isOpen()

◆ close()

◆ fetch()

◆ fetchBatch()

◆ store()

◆ storeBatch()

◆ sync()

◆ for_each()

◆ getWriteLoad()

◆ setDeletePath()

◆ fdRequired()

◆ getBlockSize()

◆ open() [2/2]

◆ verify()