class to create database, launch online delete thread, and related SQLite database More...

Inheritance diagram for ripple::SHAMapStore:

Collaboration diagram for ripple::SHAMapStore:

[legend]

Public Member Functions
	SHAMapStore (Stoppable &parent)

virtual void	onLedgerClosed (std::shared_ptr< Ledger const > const &ledger)=0
	Called by LedgerMaster every time a ledger validates. More...

virtual void	rendezvous () const =0

virtual std::uint32_t	clampFetchDepth (std::uint32_t fetch_depth) const =0

virtual std::unique_ptr< NodeStore::Database >	makeNodeStore (std::string const &name, std::int32_t readThreads)=0

virtual LedgerIndex	setCanDelete (LedgerIndex canDelete)=0
	Highest ledger that may be deleted. More...

virtual bool	advisoryDelete () const =0
	Whether advisory delete is enabled. More...

virtual LedgerIndex	getLastRotated ()=0
	Maximum ledger that has been deleted, or will be deleted if currently in the act of online deletion. More...

virtual LedgerIndex	getCanDelete ()=0
	Highest ledger that may be deleted. More...

virtual int	fdRequired () const =0
	Returns the number of file descriptors that are needed. More...

virtual boost::optional< LedgerIndex >	minimumOnline () const =0
	The minimum ledger to try and maintain in our database. More...

RootStoppable &	getRoot ()

void	setParent (Stoppable &parent)
	Set the parent of this Stoppable. More...

bool	isStopping () const
	Returns `true` if the stoppable should stop. More...

bool	isStopped () const
	Returns `true` if the requested stop has completed. More...

bool	areChildrenStopped () const
	Returns `true` if all children have stopped. More...

JobCounter &	jobCounter ()

bool	alertable_sleep_until (std::chrono::system_clock::time_point const &t)
	Sleep or wake up on stop. More...

Protected Member Functions
void	stopped ()
	Called by derived classes to indicate that the stoppable has stopped. More...

Private Types
using	Children = beast::LockFreeStack< Child >

Private Member Functions
virtual void	onPrepare ()
	Override called during preparation. More...

virtual void	onStart ()
	Override called during start. More...

virtual void	onStop ()
	Override called when the stop notification is issued. More...

virtual void	onChildrenStopped ()
	Override called when all children have stopped. More...

void	prepareRecursive ()

void	startRecursive ()

void	stopAsyncRecursive (beast::Journal j)

void	stopRecursive (beast::Journal j)

Private Attributes
std::string	m_name

RootStoppable &	m_root

Child	m_child

std::atomic< bool >	m_stopped {false}

std::atomic< bool >	m_childrenStopped {false}

Children	m_children

std::condition_variable	m_cv

std::mutex	m_mut

bool	m_is_stopping = false

bool	hasParent_ {false}

Detailed Description

class to create database, launch online delete thread, and related SQLite database

Definition at line 37 of file SHAMapStore.h.

Member Typedef Documentation

◆ Children

using ripple::Stoppable::Children = beast::LockFreeStack<Child>

privateinherited

Definition at line 318 of file Stoppable.h.

Constructor & Destructor Documentation

◆ SHAMapStore()

ripple::SHAMapStore::SHAMapStore ( Stoppable & parent )

Definition at line 40 of file SHAMapStore.h.

Member Function Documentation

◆ onLedgerClosed()

virtual void ripple::SHAMapStore::onLedgerClosed ( std::shared_ptr< Ledger const > const & ledger )

pure virtual

Called by LedgerMaster every time a ledger validates.

Implemented in ripple::SHAMapStoreImp.

◆ rendezvous()

virtual void ripple::SHAMapStore::rendezvous ( ) const

pure virtual

Implemented in ripple::SHAMapStoreImp.

◆ clampFetchDepth()

virtual std::uint32_t ripple::SHAMapStore::clampFetchDepth ( std::uint32_t fetch_depth ) const

pure virtual

Implemented in ripple::SHAMapStoreImp.

◆ makeNodeStore()

virtual std::unique_ptr<NodeStore::Database> ripple::SHAMapStore::makeNodeStore	(	std::string const &	name,
		std::int32_t	readThreads
	)

pure virtual

Implemented in ripple::SHAMapStoreImp.

◆ setCanDelete()

virtual LedgerIndex ripple::SHAMapStore::setCanDelete ( LedgerIndex canDelete )

pure virtual

Highest ledger that may be deleted.

Implemented in ripple::SHAMapStoreImp.

◆ advisoryDelete()

virtual bool ripple::SHAMapStore::advisoryDelete ( ) const

pure virtual

Whether advisory delete is enabled.

Implemented in ripple::SHAMapStoreImp.

◆ getLastRotated()

virtual LedgerIndex ripple::SHAMapStore::getLastRotated ( )

pure virtual

Maximum ledger that has been deleted, or will be deleted if currently in the act of online deletion.

Implemented in ripple::SHAMapStoreImp.

◆ getCanDelete()

virtual LedgerIndex ripple::SHAMapStore::getCanDelete ( )

pure virtual

Highest ledger that may be deleted.

Implemented in ripple::SHAMapStoreImp.

◆ fdRequired()

virtual int ripple::SHAMapStore::fdRequired ( ) const

pure virtual

Returns the number of file descriptors that are needed.

Implemented in ripple::SHAMapStoreImp.

◆ minimumOnline()

virtual boost::optional<LedgerIndex> ripple::SHAMapStore::minimumOnline ( ) const

pure virtual

The minimum ledger to try and maintain in our database.

This defines the lower bound for attempting to acquire historical ledgers over the peer to peer network.

If online_delete is enabled, then each time online_delete executes and just prior to clearing SQL databases of historical ledgers, move the value forward to one past the greatest ledger being deleted. This minimizes fetching of ledgers that are in the process of being deleted. Without online_delete or before online_delete is executed, this value is always the minimum value persisted in the ledger database, if any.

Returns: The minimum ledger sequence to keep online based on the description above. If not set, then an unseated optional.

Implemented in ripple::SHAMapStoreImp.

◆ getRoot()

RootStoppable& ripple::Stoppable::getRoot ( )

inherited

Definition at line 213 of file Stoppable.h.

◆ setParent()

void ripple::Stoppable::setParent ( Stoppable & parent )

inherited

Set the parent of this Stoppable.

Note: The Stoppable must not already have a parent. The parent to be set cannot not be stopping. Both roots must match.

Definition at line 43 of file Stoppable.cpp.

◆ isStopping()

bool ripple::Stoppable::isStopping ( ) const

inherited

Returns true if the stoppable should stop.

Definition at line 54 of file Stoppable.cpp.

◆ isStopped()

bool ripple::Stoppable::isStopped ( ) const

inherited

Returns true if the requested stop has completed.

Definition at line 60 of file Stoppable.cpp.

◆ areChildrenStopped()

bool ripple::Stoppable::areChildrenStopped ( ) const

inherited

Returns true if all children have stopped.

Definition at line 66 of file Stoppable.cpp.

◆ jobCounter()

JobCounter & ripple::Stoppable::jobCounter ( )

inherited

Definition at line 436 of file Stoppable.h.

◆ alertable_sleep_until()

bool ripple::Stoppable::alertable_sleep_until ( std::chrono::system_clock::time_point const & t )

inherited

Sleep or wake up on stop.

Returns: true if we are stopping

Definition at line 454 of file Stoppable.h.

◆ stopped()

void ripple::Stoppable::stopped ( )

protectedinherited

Called by derived classes to indicate that the stoppable has stopped.

Definition at line 72 of file Stoppable.cpp.

◆ onPrepare()

void ripple::Stoppable::onPrepare ( )

privatevirtualinherited

Override called during preparation.

Since all other Stoppable objects in the tree have already been constructed, this provides an opportunity to perform initialization which depends on calling into other Stoppable objects. This call is made on the same thread that called prepare(). The default implementation does nothing. Guaranteed to only be called once.

Definition at line 80 of file Stoppable.cpp.

◆ onStart()

void ripple::Stoppable::onStart ( )

privatevirtualinherited

◆ onStop()

void ripple::Stoppable::onStop ( )

privatevirtualinherited

Override called when the stop notification is issued.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation simply calls stopped(). This is applicable when the Stoppable has a trivial stop operation (or no stop operation), and we are merely using the Stoppable API to position it as a dependency of some parent service.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Definition at line 90 of file Stoppable.cpp.

◆ onChildrenStopped()

void ripple::Stoppable::onChildrenStopped ( )

privatevirtualinherited

Override called when all children have stopped.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation does nothing.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Definition at line 96 of file Stoppable.cpp.

◆ prepareRecursive()

void ripple::Stoppable::prepareRecursive ( )

privateinherited

Definition at line 103 of file Stoppable.cpp.

◆ startRecursive()

void ripple::Stoppable::startRecursive ( )

privateinherited

Definition at line 113 of file Stoppable.cpp.

◆ stopAsyncRecursive()

void ripple::Stoppable::stopAsyncRecursive ( beast::Journal j )

privateinherited

Definition at line 123 of file Stoppable.cpp.

◆ stopRecursive()

void ripple::Stoppable::stopRecursive ( beast::Journal j )

privateinherited

Definition at line 134 of file Stoppable.cpp.

Member Data Documentation

◆ m_name

std::string ripple::Stoppable::m_name

privateinherited

Definition at line 338 of file Stoppable.h.

◆ m_root

RootStoppable& ripple::Stoppable::m_root

privateinherited

Definition at line 339 of file Stoppable.h.

◆ m_child

Child ripple::Stoppable::m_child

privateinherited

Definition at line 340 of file Stoppable.h.

◆ m_stopped

std::atomic<bool> ripple::Stoppable::m_stopped {false}

privateinherited

Definition at line 341 of file Stoppable.h.

◆ m_childrenStopped

std::atomic<bool> ripple::Stoppable::m_childrenStopped {false}

privateinherited

Definition at line 342 of file Stoppable.h.

◆ m_children

Children ripple::Stoppable::m_children

privateinherited

Definition at line 343 of file Stoppable.h.

◆ m_cv

std::condition_variable ripple::Stoppable::m_cv

privateinherited

Definition at line 344 of file Stoppable.h.

◆ m_mut

std::mutex ripple::Stoppable::m_mut

privateinherited

Definition at line 345 of file Stoppable.h.

◆ m_is_stopping

bool ripple::Stoppable::m_is_stopping = false

privateinherited

Definition at line 346 of file Stoppable.h.

◆ hasParent_

bool ripple::Stoppable::hasParent_ {false}

privateinherited

Definition at line 347 of file Stoppable.h.

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Children

Constructor & Destructor Documentation

◆ SHAMapStore()

Member Function Documentation

◆ onLedgerClosed()

◆ rendezvous()

◆ clampFetchDepth()

◆ makeNodeStore()

◆ setCanDelete()

◆ advisoryDelete()

◆ getLastRotated()

◆ getCanDelete()

◆ fdRequired()

◆ minimumOnline()

◆ getRoot()

◆ setParent()

◆ isStopping()

◆ isStopped()

◆ areChildrenStopped()

◆ jobCounter()

◆ alertable_sleep_until()

◆ stopped()

◆ onPrepare()

◆ onStart()

◆ onStop()

◆ onChildrenStopped()

◆ prepareRecursive()

◆ startRecursive()

◆ stopAsyncRecursive()

◆ stopRecursive()

Member Data Documentation

◆ m_name

◆ m_root

◆ m_child

◆ m_stopped

◆ m_childrenStopped

◆ m_children

◆ m_cv

◆ m_mut

◆ m_is_stopping

◆ hasParent_