xrpl::LedgerCleanerImp Class Reference

Inheritance diagram for xrpl::LedgerCleanerImp:

Collaboration diagram for xrpl::LedgerCleanerImp:

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	writeOne (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 *	findOneDeep (std::string const &name)
PropertyStream::Source *	findPath (std::string path)
PropertyStream::Source *	findOne (std::string const &name)

Static Public Member Functions
static bool	peelLeadingSlash (std::string *path)
static bool	peelTrailingSlashstar (std::string *path)
static std::string	peelName (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	name_
std::recursive_mutex	lock_
Item	item_
Source *	parent_ {nullptr}
List< Item >	children_

Detailed Description

Definition at line 49 of file app/ledger/detail/LedgerCleaner.cpp.

Member Enumeration Documentation

State

enum class xrpl::LedgerCleanerImp::State : char

strongprivate

Enumerator
NotCleaning
Cleaning

Definition at line 59 of file app/ledger/detail/LedgerCleaner.cpp.

Constructor & Destructor Documentation

LedgerCleanerImp()

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

Definition at line 80 of file app/ledger/detail/LedgerCleaner.cpp.

~LedgerCleanerImp()

xrpl::LedgerCleanerImp::~LedgerCleanerImp ( )

override

Definition at line 84 of file app/ledger/detail/LedgerCleaner.cpp.

Member Function Documentation

start()

void xrpl::LedgerCleanerImp::start ( )

overridevirtual

Implements xrpl::LedgerCleaner.

Definition at line 91 of file app/ledger/detail/LedgerCleaner.cpp.

stop()

void xrpl::LedgerCleanerImp::stop ( )

overridevirtual

Implements xrpl::LedgerCleaner.

Definition at line 97 of file app/ledger/detail/LedgerCleaner.cpp.

onWrite()

void xrpl::LedgerCleanerImp::onWrite ( beast::PropertyStream::Map & map )

overridevirtual

Subclass override.

The default version does nothing.

Reimplemented from beast::PropertyStream::Source.

Definition at line 115 of file app/ledger/detail/LedgerCleaner.cpp.

clean()

void xrpl::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 xrpl::LedgerCleaner.

Definition at line 142 of file app/ledger/detail/LedgerCleaner.cpp.

run()

void xrpl::LedgerCleanerImp::run ( )

private

Definition at line 226 of file app/ledger/detail/LedgerCleaner.cpp.

getLedgerHash()

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

private

Definition at line 247 of file app/ledger/detail/LedgerCleaner.cpp.

doLedger()

bool xrpl::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 app/ledger/detail/LedgerCleaner.cpp.

getHash()

LedgerHash xrpl::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 331 of file app/ledger/detail/LedgerCleaner.cpp.

doLedgerCleaner()

void xrpl::LedgerCleanerImp::doLedgerCleaner ( )

private

Run the ledger cleaner.

Definition at line 382 of file app/ledger/detail/LedgerCleaner.cpp.

name()

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

nodiscardinherited

Returns the name of this source.

Definition at line 168 of file beast_PropertyStream.cpp.

add() [1/2]

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

inherited

Add a child source.

Definition at line 174 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 349 of file PropertyStream.h.

remove()

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

inherited

Remove a child source from this Source.

Definition at line 185 of file beast_PropertyStream.cpp.

removeAll()

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

inherited

Remove all child sources from this Source.

Definition at line 196 of file beast_PropertyStream.cpp.

writeOne()

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

inherited

Write only this Source to the stream.

Definition at line 209 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 216 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 228 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 descendent "parent.grandchild." starts at the parent and prints down to grandchild "parent.grandchild.*" starts at parent, print through grandchild children

Definition at line 246 of file beast_PropertyStream.cpp.

findOneDeep()

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

inherited

Definition at line 317 of file beast_PropertyStream.cpp.

findPath()

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

inherited

Definition at line 334 of file beast_PropertyStream.cpp.

findOne()

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

inherited

Definition at line 352 of file beast_PropertyStream.cpp.

peelLeadingSlash()

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

staticinherited

Definition at line 266 of file beast_PropertyStream.cpp.

peelTrailingSlashstar()

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

staticinherited

Definition at line 277 of file beast_PropertyStream.cpp.

peelName()

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

staticinherited

Definition at line 293 of file beast_PropertyStream.cpp.

Member Data Documentation

app_

Application& xrpl::LedgerCleanerImp::app_

private

Definition at line 51 of file app/ledger/detail/LedgerCleaner.cpp.

j_

beast::Journal const xrpl::LedgerCleanerImp::j_

private

Definition at line 52 of file app/ledger/detail/LedgerCleaner.cpp.

mutex_

std::mutex xrpl::LedgerCleanerImp::mutex_

mutableprivate

Definition at line 53 of file app/ledger/detail/LedgerCleaner.cpp.

wakeup_

std::condition_variable xrpl::LedgerCleanerImp::wakeup_

mutableprivate

Definition at line 55 of file app/ledger/detail/LedgerCleaner.cpp.

thread_

std::thread xrpl::LedgerCleanerImp::thread_

private

Definition at line 57 of file app/ledger/detail/LedgerCleaner.cpp.

state_

State xrpl::LedgerCleanerImp::state_ = State::NotCleaning

private

Definition at line 60 of file app/ledger/detail/LedgerCleaner.cpp.

shouldExit_

bool xrpl::LedgerCleanerImp::shouldExit_ = false

private

Definition at line 61 of file app/ledger/detail/LedgerCleaner.cpp.

minRange_

LedgerIndex xrpl::LedgerCleanerImp::minRange_ = 0

private

Definition at line 64 of file app/ledger/detail/LedgerCleaner.cpp.

maxRange_

LedgerIndex xrpl::LedgerCleanerImp::maxRange_ = 0

private

Definition at line 67 of file app/ledger/detail/LedgerCleaner.cpp.

checkNodes_

bool xrpl::LedgerCleanerImp::checkNodes_ = false

private

Definition at line 70 of file app/ledger/detail/LedgerCleaner.cpp.

fixTxns_

bool xrpl::LedgerCleanerImp::fixTxns_ = false

private

Definition at line 73 of file app/ledger/detail/LedgerCleaner.cpp.

failures_

int xrpl::LedgerCleanerImp::failures_ = 0

private

Definition at line 76 of file app/ledger/detail/LedgerCleaner.cpp.

name_

std::string const beast::PropertyStream::Source::name_

privateinherited

Definition at line 317 of file PropertyStream.h.

lock_

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

privateinherited

Definition at line 318 of file PropertyStream.h.

item_

Item beast::PropertyStream::Source::item_

privateinherited

Definition at line 319 of file PropertyStream.h.

parent_

Source* beast::PropertyStream::Source::parent_ {nullptr}

privateinherited

Definition at line 320 of file PropertyStream.h.

children_

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

privateinherited

Definition at line 321 of file PropertyStream.h.