xrpl::LedgerCleaner Class Reference

Check the ledger/transaction databases to make sure they have continuity. More...

#include <LedgerCleaner.h>

Inheritance diagram for xrpl::LedgerCleaner:

Collaboration diagram for xrpl::LedgerCleaner:

Public Member Functions
virtual	~LedgerCleaner ()=default
virtual void	start ()=0
virtual void	stop ()=0
virtual void	clean (Json::Value const &parameters)=0
	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)
virtual void	onWrite (Map &)
	Subclass override.

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)

Protected Member Functions
	LedgerCleaner ()

Private Attributes
std::string const	m_name
std::recursive_mutex	lock_
Item	item_
Source *	parent_ {nullptr}
List< Item >	children_

Detailed Description

Check the ledger/transaction databases to make sure they have continuity.

Definition at line 12 of file LedgerCleaner.h.

Constructor & Destructor Documentation

LedgerCleaner()

xrpl::LedgerCleaner::LedgerCleaner ( )

protected

Definition at line 15 of file LedgerCleaner.h.

~LedgerCleaner()

virtual xrpl::LedgerCleaner::~LedgerCleaner ( )

virtualdefault

Member Function Documentation

start()

virtual void xrpl::LedgerCleaner::start ( )

pure virtual

Implemented in xrpl::LedgerCleanerImp.

stop()

virtual void xrpl::LedgerCleaner::stop ( )

pure virtual

Implemented in xrpl::LedgerCleanerImp.

clean()

virtual void xrpl::LedgerCleaner::clean ( Json::Value const &  parameters )

pure virtual

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.

Implemented in xrpl::LedgerCleanerImp.

name()

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

inherited

Returns the name of this source.

Definition at line 167 of file beast_PropertyStream.cpp.

add() [1/2]

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

inherited

Add a child source.

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

remove()

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

inherited

Remove a child source from this Source.

Definition at line 186 of file beast_PropertyStream.cpp.

removeAll()

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

inherited

Remove all child sources from this Source.

Definition at line 199 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 212 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 219 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 231 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 249 of file beast_PropertyStream.cpp.

find_one_deep()

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

inherited

Definition at line 320 of file beast_PropertyStream.cpp.

find_path()

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

inherited

Definition at line 337 of file beast_PropertyStream.cpp.

find_one()

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

inherited

Definition at line 355 of file beast_PropertyStream.cpp.

peel_leading_slash()

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

staticinherited

Definition at line 269 of file beast_PropertyStream.cpp.

peel_trailing_slashstar()

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

staticinherited

Definition at line 280 of file beast_PropertyStream.cpp.

peel_name()

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

staticinherited

Definition at line 296 of file beast_PropertyStream.cpp.

onWrite()

void beast::PropertyStream::Source::onWrite ( Map &  )

virtualinherited

Subclass override.

The default version does nothing.

Reimplemented in xrpl::Resource::ManagerImp, xrpl::LedgerCleanerImp, xrpl::PeerFinder::ManagerImp, xrpl::ApplicationImp, and xrpl::OverlayImpl.

Definition at line 367 of file beast_PropertyStream.cpp.

Member Data Documentation

m_name

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

privateinherited

Definition at line 311 of file PropertyStream.h.

lock_

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

privateinherited

Definition at line 312 of file PropertyStream.h.

item_

Item beast::PropertyStream::Source::item_

privateinherited

Definition at line 313 of file PropertyStream.h.

parent_

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

privateinherited

Definition at line 314 of file PropertyStream.h.

children_

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

privateinherited

Definition at line 315 of file PropertyStream.h.