Inheritance diagram for ripple::LedgerCleanerImp:

[legend]

Collaboration diagram for ripple::LedgerCleanerImp:

[legend]

Public Member Functions
	LedgerCleanerImp (Application &app, beast::Journal journal)

	~LedgerCleanerImp () override

void	start () override

void	stop () override

void	onWrite (beast::PropertyStream::Map &map) override
	Subclass override.

void	clean (Json::Value const &params) override
	Start a long running task to clean the ledger.

std::string const &	name () const
	Returns the name of this source.

void	add (Source &source)
	Add a child source.

template<class Derived >
Derived *	add (Derived *child)
	Add a child source by pointer.

void	remove (Source &child)
	Remove a child source from this Source.

void	removeAll ()
	Remove all child sources from this Source.

void	write_one (PropertyStream &stream)
	Write only this Source to the stream.

void	write (PropertyStream &stream)
	write this source and all its children recursively to the stream.

void	write (PropertyStream &stream, std::string const &path)
	Parse the path and write the corresponding Source and optional children.

std::pair< Source *, bool >	find (std::string path)
	Parse the dot-delimited Source path and return the result.

Source *	find_one_deep (std::string const &name)

PropertyStream::Source *	find_path (std::string path)

PropertyStream::Source *	find_one (std::string const &name)

Static Public Member Functions
static bool	peel_leading_slash (std::string *path)

static bool	peel_trailing_slashstar (std::string *path)

static std::string	peel_name (std::string *path)

Private Types
enum class	State : char { notCleaning = 0 , cleaning }

Private Member Functions
void	run ()

LedgerHash	getLedgerHash (std::shared_ptr< ReadView const > &ledger, LedgerIndex index)

bool	doLedger (LedgerIndex const &ledgerIndex, LedgerHash const &ledgerHash, bool doNodes, bool doTxns)
	Process a single ledger.

LedgerHash	getHash (LedgerIndex const &ledgerIndex, std::shared_ptr< ReadView const > &referenceLedger)
	Returns the hash of the specified ledger.

void	doLedgerCleaner ()
	Run the ledger cleaner.

Private Attributes
Application &	app_

beast::Journal const	j_

std::mutex	mutex_

std::condition_variable	wakeup_

std::thread	thread_

State	state_ = State::notCleaning

bool	shouldExit_ = false

LedgerIndex	minRange_ = 0

LedgerIndex	maxRange_ = 0

bool	checkNodes_ = false

bool	fixTxns_ = false

int	failures_ = 0

std::string const	m_name

std::recursive_mutex	lock_

Item	item_

Source *	parent_

List< Item >	children_

Detailed Description

Definition at line 44 of file LedgerCleaner.cpp.

Member Enumeration Documentation

◆ State

enum class ripple::LedgerCleanerImp::State : char

strongprivate

Enumerator
notCleaning
cleaning

Definition at line 54 of file LedgerCleaner.cpp.

Constructor & Destructor Documentation

◆ LedgerCleanerImp()

ripple::LedgerCleanerImp::LedgerCleanerImp	(	Application &	app,
		beast::Journal	journal
	)

Definition at line 75 of file LedgerCleaner.cpp.

◆ ~LedgerCleanerImp()

ripple::LedgerCleanerImp::~LedgerCleanerImp ( )

override

Definition at line 80 of file LedgerCleaner.cpp.

Member Function Documentation

◆ start()

void ripple::LedgerCleanerImp::start ( )

overridevirtual

Implements ripple::LedgerCleaner.

Definition at line 87 of file LedgerCleaner.cpp.

◆ stop()

void ripple::LedgerCleanerImp::stop ( )

overridevirtual

Implements ripple::LedgerCleaner.

Definition at line 93 of file LedgerCleaner.cpp.

◆ onWrite()

void ripple::LedgerCleanerImp::onWrite ( beast::PropertyStream::Map & )

overridevirtual

Subclass override.

The default version does nothing.

Reimplemented from beast::PropertyStream::Source.

Definition at line 111 of file LedgerCleaner.cpp.

◆ clean()

void ripple::LedgerCleanerImp::clean ( Json::Value const & parameters )

overridevirtual

Start a long running task to clean the ledger.

The ledger is cleaned asynchronously, on an implementation defined thread. This function call does not block. The long running task will be stopped by a call to stop().

Thread safety: Safe to call from any thread at any time.

Parameters

parameters A Json object with configurable parameters.

Implements ripple::LedgerCleaner.

Definition at line 136 of file LedgerCleaner.cpp.

◆ run()

void ripple::LedgerCleanerImp::run ( )

private

Definition at line 220 of file LedgerCleaner.cpp.

◆ getLedgerHash()

LedgerHash ripple::LedgerCleanerImp::getLedgerHash	(	std::shared_ptr< ReadView const > &	ledger,
		LedgerIndex	index
	)

private

Definition at line 245 of file LedgerCleaner.cpp.

◆ doLedger()

bool ripple::LedgerCleanerImp::doLedger	(	LedgerIndex const &	ledgerIndex,
		LedgerHash const &	ledgerHash,
		bool	doNodes,
		bool	doTxns
	)

private

Process a single ledger.

Parameters

ledgerIndex	The index of the ledger to process.
ledgerHash	The known correct hash of the ledger.
doNodes	Ensure all ledger nodes are in the node db.
doTxns	Reprocess (account) transactions to SQL databases.

Returns: true if the ledger was cleaned.

Definition at line 272 of file LedgerCleaner.cpp.

◆ getHash()

LedgerHash ripple::LedgerCleanerImp::getHash	(	LedgerIndex const &	ledgerIndex,
		std::shared_ptr< ReadView const > &	referenceLedger
	)

private

Returns the hash of the specified ledger.

Parameters

ledgerIndex	The index of the desired ledger.
referenceLedger	[out] An optional known good subsequent ledger.

Returns: The hash of the ledger. This will be all-bits-zero if not found.

Definition at line 330 of file LedgerCleaner.cpp.

◆ doLedgerCleaner()

void ripple::LedgerCleanerImp::doLedgerCleaner ( )

private

Run the ledger cleaner.

Definition at line 382 of file LedgerCleaner.cpp.

◆ name()

std::string const & beast::PropertyStream::Source::name ( ) const

inherited

Returns the name of this source.

Definition at line 193 of file beast_PropertyStream.cpp.

◆ add() [1/2]

void beast::PropertyStream::Source::add ( Source & source )

inherited

Add a child source.

Definition at line 199 of file beast_PropertyStream.cpp.

◆ add() [2/2]

template<class Derived >

Derived * beast::PropertyStream::Source::add ( Derived * child )

inherited

Add a child source by pointer.

The source pointer is returned so it can be used in ctor-initializers.

Definition at line 358 of file PropertyStream.h.

◆ remove()

void beast::PropertyStream::Source::remove ( Source & child )

inherited

Remove a child source from this Source.

Definition at line 213 of file beast_PropertyStream.cpp.

◆ removeAll()

void beast::PropertyStream::Source::removeAll ( )

inherited

Remove all child sources from this Source.

Definition at line 227 of file beast_PropertyStream.cpp.

◆ write_one()

void beast::PropertyStream::Source::write_one ( PropertyStream & stream )

inherited

Write only this Source to the stream.

Definition at line 240 of file beast_PropertyStream.cpp.

◆ write() [1/2]

void beast::PropertyStream::Source::write ( PropertyStream & stream )

inherited

write this source and all its children recursively to the stream.

Definition at line 247 of file beast_PropertyStream.cpp.

◆ write() [2/2]

void beast::PropertyStream::Source::write	(	PropertyStream &	stream,
		std::string const &	path
	)

inherited

Parse the path and write the corresponding Source and optional children.

If the source is found, it is written. If the wildcard character '*' exists as the last character in the path, then all the children are written recursively.

Definition at line 259 of file beast_PropertyStream.cpp.

◆ find()

std::pair< PropertyStream::Source *, bool > beast::PropertyStream::Source::find ( std::string path )

inherited

Parse the dot-delimited Source path and return the result.

The first value will be a pointer to the Source object corresponding to the given path. If no Source object exists, then the first value will be nullptr and the second value will be undefined. The second value is a boolean indicating whether or not the path string specifies the wildcard character '*' as the last character.

print statement examples "parent.child" prints child and all of its children "parent.child." start at the parent and print down to child "parent.grandchild" prints nothing- grandchild not direct discendent "parent.grandchild." starts at the parent and prints down to grandchild "parent.grandchild.*" starts at parent, print through grandchild children

Definition at line 273 of file beast_PropertyStream.cpp.

◆ find_one_deep()

PropertyStream::Source * beast::PropertyStream::Source::find_one_deep ( std::string const & name )

inherited

Definition at line 340 of file beast_PropertyStream.cpp.

◆ find_path()

PropertyStream::Source * beast::PropertyStream::Source::find_path ( std::string path )

inherited

Definition at line 357 of file beast_PropertyStream.cpp.

◆ find_one()

PropertyStream::Source * beast::PropertyStream::Source::find_one ( std::string const & name )

inherited

Definition at line 375 of file beast_PropertyStream.cpp.

◆ peel_leading_slash()

bool beast::PropertyStream::Source::peel_leading_slash ( std::string * path )

staticinherited

Definition at line 293 of file beast_PropertyStream.cpp.

◆ peel_trailing_slashstar()

bool beast::PropertyStream::Source::peel_trailing_slashstar ( std::string * path )

staticinherited

Definition at line 304 of file beast_PropertyStream.cpp.

◆ peel_name()

std::string beast::PropertyStream::Source::peel_name ( std::string * path )

staticinherited

Definition at line 320 of file beast_PropertyStream.cpp.

Member Data Documentation

◆ app_

Application& ripple::LedgerCleanerImp::app_

private

Definition at line 46 of file LedgerCleaner.cpp.

◆ j_

beast::Journal const ripple::LedgerCleanerImp::j_

private

Definition at line 47 of file LedgerCleaner.cpp.

◆ mutex_

std::mutex ripple::LedgerCleanerImp::mutex_

mutableprivate

Definition at line 48 of file LedgerCleaner.cpp.

◆ wakeup_

std::condition_variable ripple::LedgerCleanerImp::wakeup_

mutableprivate

Definition at line 50 of file LedgerCleaner.cpp.

◆ thread_

std::thread ripple::LedgerCleanerImp::thread_

private

Definition at line 52 of file LedgerCleaner.cpp.

◆ state_

State ripple::LedgerCleanerImp::state_ = State::notCleaning

private

Definition at line 55 of file LedgerCleaner.cpp.

◆ shouldExit_

bool ripple::LedgerCleanerImp::shouldExit_ = false

private

Definition at line 56 of file LedgerCleaner.cpp.

◆ minRange_

LedgerIndex ripple::LedgerCleanerImp::minRange_ = 0

private

Definition at line 59 of file LedgerCleaner.cpp.

◆ maxRange_

LedgerIndex ripple::LedgerCleanerImp::maxRange_ = 0

private

Definition at line 62 of file LedgerCleaner.cpp.

◆ checkNodes_

bool ripple::LedgerCleanerImp::checkNodes_ = false

private

Definition at line 65 of file LedgerCleaner.cpp.

◆ fixTxns_

bool ripple::LedgerCleanerImp::fixTxns_ = false

private

Definition at line 68 of file LedgerCleaner.cpp.

◆ failures_

int ripple::LedgerCleanerImp::failures_ = 0

private

Definition at line 71 of file LedgerCleaner.cpp.

◆ m_name

std::string const beast::PropertyStream::Source::m_name

privateinherited

Definition at line 331 of file PropertyStream.h.

◆ lock_

std::recursive_mutex beast::PropertyStream::Source::lock_

privateinherited

Definition at line 332 of file PropertyStream.h.

◆ item_

Item beast::PropertyStream::Source::item_

privateinherited

Definition at line 333 of file PropertyStream.h.

◆ parent_

Source* beast::PropertyStream::Source::parent_

privateinherited

Definition at line 334 of file PropertyStream.h.

◆ children_

List<Item> beast::PropertyStream::Source::children_

privateinherited

Definition at line 335 of file PropertyStream.h.

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ LedgerCleanerImp()

◆ ~LedgerCleanerImp()

Member Function Documentation

◆ start()

◆ stop()

◆ onWrite()

◆ clean()

◆ run()

◆ getLedgerHash()

◆ doLedger()

◆ getHash()

◆ doLedgerCleaner()

◆ name()

◆ add() [1/2]

◆ add() [2/2]

◆ remove()

◆ removeAll()

◆ write_one()

◆ write() [1/2]

◆ write() [2/2]

◆ find()

◆ find_one_deep()

◆ find_path()

◆ find_one()

◆ peel_leading_slash()

◆ peel_trailing_slashstar()

◆ peel_name()

Member Data Documentation

◆ app_

◆ j_

◆ mutex_

◆ wakeup_

◆ thread_

◆ state_

◆ shouldExit_

◆ minRange_

◆ maxRange_

◆ checkNodes_

◆ fixTxns_

◆ failures_

◆ m_name

◆ lock_

◆ item_

◆ parent_

◆ children_