#include <Application.h>

Inheritance diagram for xrpl::Application:

[legend]

Collaboration diagram for xrpl::Application:

[legend]

Public Types
using	MutexType = std::recursive_mutex

Public Member Functions
virtual MutexType &	getMasterMutex ()=0

	Application ()

virtual	~Application ()=default

virtual bool	setup (boost::program_options::variables_map const &options)=0

virtual void	start (bool withTimers)=0

virtual void	run ()=0

virtual void	signalStop (std::string msg)=0

virtual bool	checkSigs () const =0

virtual void	checkSigs (bool)=0

virtual bool	isStopping () const =0

virtual std::uint64_t	instanceID () const =0
	Returns a 64-bit instance identifier, generated at startup.

virtual Logs &	logs ()=0

virtual Config &	config ()=0

virtual boost::asio::io_context &	getIOContext ()=0

virtual CollectorManager &	getCollectorManager ()=0

virtual Family &	getNodeFamily ()=0

virtual TimeKeeper &	timeKeeper ()=0

virtual JobQueue &	getJobQueue ()=0

virtual NodeCache &	getTempNodeCache ()=0

virtual CachedSLEs &	cachedSLEs ()=0

virtual AmendmentTable &	getAmendmentTable ()=0

virtual HashRouter &	getHashRouter ()=0

virtual LoadFeeTrack &	getFeeTrack ()=0

virtual LoadManager &	getLoadManager ()=0

virtual Overlay &	overlay ()=0

virtual TxQ &	getTxQ ()=0

virtual ValidatorList &	validators ()=0

virtual ValidatorSite &	validatorSites ()=0

virtual ManifestCache &	validatorManifests ()=0

virtual ManifestCache &	publisherManifests ()=0

virtual Cluster &	cluster ()=0

virtual PeerReservationTable &	peerReservations ()=0

virtual RCLValidations &	getValidations ()=0

virtual NodeStore::Database &	getNodeStore ()=0

virtual InboundLedgers &	getInboundLedgers ()=0

virtual InboundTransactions &	getInboundTransactions ()=0

virtual TaggedCache< uint256, AcceptedLedger > &	getAcceptedLedgerCache ()=0

virtual LedgerMaster &	getLedgerMaster ()=0

virtual LedgerCleaner &	getLedgerCleaner ()=0

virtual LedgerReplayer &	getLedgerReplayer ()=0

virtual NetworkOPs &	getOPs ()=0

virtual OrderBookDB &	getOrderBookDB ()=0

virtual ServerHandler &	getServerHandler ()=0

virtual TransactionMaster &	getMasterTransaction ()=0

virtual perf::PerfLog &	getPerfLog ()=0

virtual std::pair< PublicKey, SecretKey > const &	nodeIdentity ()=0

virtual std::optional< PublicKey const >	getValidationPublicKey () const =0

virtual Resource::Manager &	getResourceManager ()=0

virtual PathRequests &	getPathRequests ()=0

virtual SHAMapStore &	getSHAMapStore ()=0

virtual PendingSaves &	pendingSaves ()=0

virtual OpenLedger &	openLedger ()=0

virtual OpenLedger const &	openLedger () const =0

virtual RelationalDatabase &	getRelationalDatabase ()=0

virtual std::chrono::milliseconds	getIOLatency ()=0

virtual bool	serverOkay (std::string &reason)=0

virtual beast::Journal	journal (std::string const &name)=0

virtual int	fdRequired () const =0

virtual DatabaseCon &	getWalletDB ()=0
	Retrieve the "wallet database".

virtual LedgerIndex	getMaxDisallowedLedger ()=0
	Ensure that a newly-started validator does not sign proposals older than the last ledger it persisted.

virtual std::optional< uint256 > const &	trapTxID () const =0

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)

Private Attributes
std::string const	m_name

std::recursive_mutex	lock_

Item	item_

Source *	parent_

List< Item >	children_

Detailed Description

Definition at line 94 of file Application.h.

Member Typedef Documentation

◆ MutexType

using xrpl::Application::MutexType = std::recursive_mutex

Definition at line 108 of file Application.h.

Constructor & Destructor Documentation

◆ Application()

xrpl::Application::Application ( )

Definition at line 2172 of file Application.cpp.

◆ ~Application()

virtual xrpl::Application::~Application ( )

virtualdefault

Member Function Documentation

◆ getMasterMutex()

virtual MutexType & xrpl::Application::getMasterMutex ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ setup()

virtual bool xrpl::Application::setup ( boost::program_options::variables_map const & options )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ start()

virtual void xrpl::Application::start ( bool withTimers )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ run()

virtual void xrpl::Application::run ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ signalStop()

virtual void xrpl::Application::signalStop ( std::string msg )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ checkSigs() [1/2]

virtual bool xrpl::Application::checkSigs ( ) const

pure virtual

Implemented in xrpl::ApplicationImp.

◆ checkSigs() [2/2]

virtual void xrpl::Application::checkSigs ( bool )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ isStopping()

virtual bool xrpl::Application::isStopping ( ) const

pure virtual

Implemented in xrpl::ApplicationImp.

◆ instanceID()

virtual std::uint64_t xrpl::Application::instanceID ( ) const

pure virtual

Returns a 64-bit instance identifier, generated at startup.

Implemented in xrpl::ApplicationImp.

◆ logs()

virtual Logs & xrpl::Application::logs ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ config()

virtual Config & xrpl::Application::config ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getIOContext()

virtual boost::asio::io_context & xrpl::Application::getIOContext ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getCollectorManager()

virtual CollectorManager & xrpl::Application::getCollectorManager ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getNodeFamily()

virtual Family & xrpl::Application::getNodeFamily ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ timeKeeper()

virtual TimeKeeper & xrpl::Application::timeKeeper ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getJobQueue()

virtual JobQueue & xrpl::Application::getJobQueue ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getTempNodeCache()

virtual NodeCache & xrpl::Application::getTempNodeCache ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ cachedSLEs()

virtual CachedSLEs & xrpl::Application::cachedSLEs ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getAmendmentTable()

virtual AmendmentTable & xrpl::Application::getAmendmentTable ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getHashRouter()

virtual HashRouter & xrpl::Application::getHashRouter ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getFeeTrack()

virtual LoadFeeTrack & xrpl::Application::getFeeTrack ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getLoadManager()

virtual LoadManager & xrpl::Application::getLoadManager ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ overlay()

virtual Overlay & xrpl::Application::overlay ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getTxQ()

virtual TxQ & xrpl::Application::getTxQ ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ validators()

virtual ValidatorList & xrpl::Application::validators ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ validatorSites()

virtual ValidatorSite & xrpl::Application::validatorSites ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ validatorManifests()

virtual ManifestCache & xrpl::Application::validatorManifests ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ publisherManifests()

virtual ManifestCache & xrpl::Application::publisherManifests ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ cluster()

virtual Cluster & xrpl::Application::cluster ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ peerReservations()

virtual PeerReservationTable & xrpl::Application::peerReservations ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getValidations()

virtual RCLValidations & xrpl::Application::getValidations ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getNodeStore()

virtual NodeStore::Database & xrpl::Application::getNodeStore ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getInboundLedgers()

virtual InboundLedgers & xrpl::Application::getInboundLedgers ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getInboundTransactions()

virtual InboundTransactions & xrpl::Application::getInboundTransactions ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getAcceptedLedgerCache()

virtual TaggedCache< uint256, AcceptedLedger > & xrpl::Application::getAcceptedLedgerCache ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getLedgerMaster()

virtual LedgerMaster & xrpl::Application::getLedgerMaster ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getLedgerCleaner()

virtual LedgerCleaner & xrpl::Application::getLedgerCleaner ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getLedgerReplayer()

virtual LedgerReplayer & xrpl::Application::getLedgerReplayer ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getOPs()

virtual NetworkOPs & xrpl::Application::getOPs ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getOrderBookDB()

virtual OrderBookDB & xrpl::Application::getOrderBookDB ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getServerHandler()

virtual ServerHandler & xrpl::Application::getServerHandler ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getMasterTransaction()

virtual TransactionMaster & xrpl::Application::getMasterTransaction ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getPerfLog()

virtual perf::PerfLog & xrpl::Application::getPerfLog ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ nodeIdentity()

virtual std::pair< PublicKey, SecretKey > const & xrpl::Application::nodeIdentity ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getValidationPublicKey()

virtual std::optional< PublicKey const > xrpl::Application::getValidationPublicKey ( ) const

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getResourceManager()

virtual Resource::Manager & xrpl::Application::getResourceManager ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getPathRequests()

virtual PathRequests & xrpl::Application::getPathRequests ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getSHAMapStore()

virtual SHAMapStore & xrpl::Application::getSHAMapStore ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ pendingSaves()

virtual PendingSaves & xrpl::Application::pendingSaves ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ openLedger() [1/2]

virtual OpenLedger & xrpl::Application::openLedger ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ openLedger() [2/2]

virtual OpenLedger const & xrpl::Application::openLedger ( ) const

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getRelationalDatabase()

virtual RelationalDatabase & xrpl::Application::getRelationalDatabase ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getIOLatency()

virtual std::chrono::milliseconds xrpl::Application::getIOLatency ( )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ serverOkay()

virtual bool xrpl::Application::serverOkay ( std::string & reason )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ journal()

virtual beast::Journal xrpl::Application::journal ( std::string const & name )

pure virtual

Implemented in xrpl::ApplicationImp.

◆ fdRequired()

virtual int xrpl::Application::fdRequired ( ) const

pure virtual

Implemented in xrpl::ApplicationImp.

◆ getWalletDB()

virtual DatabaseCon & xrpl::Application::getWalletDB ( )

pure virtual

Retrieve the "wallet database".

Implemented in xrpl::ApplicationImp.

◆ getMaxDisallowedLedger()

virtual LedgerIndex xrpl::Application::getMaxDisallowedLedger ( )

pure virtual

Ensure that a newly-started validator does not sign proposals older than the last ledger it persisted.

Implemented in xrpl::ApplicationImp.

◆ trapTxID()

virtual std::optional< uint256 > const & xrpl::Application::trapTxID ( ) const

pure virtual

Implemented in xrpl::ApplicationImp.

◆ name()

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

inherited

Returns the name of this source.

Definition at line 174 of file beast_PropertyStream.cpp.

◆ add() [1/2]

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

inherited

Add a child source.

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

◆ remove()

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

inherited

Remove a child source from this Source.

Definition at line 194 of file beast_PropertyStream.cpp.

◆ removeAll()

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

inherited

Remove all child sources from this Source.

Definition at line 208 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 221 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 228 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 240 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 254 of file beast_PropertyStream.cpp.

◆ find_one_deep()

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

inherited

Definition at line 321 of file beast_PropertyStream.cpp.

◆ find_path()

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

inherited

Definition at line 338 of file beast_PropertyStream.cpp.

◆ find_one()

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

inherited

Definition at line 356 of file beast_PropertyStream.cpp.

◆ peel_leading_slash()

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

staticinherited

Definition at line 274 of file beast_PropertyStream.cpp.

◆ peel_trailing_slashstar()

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

staticinherited

Definition at line 285 of file beast_PropertyStream.cpp.

◆ peel_name()

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

staticinherited

Definition at line 301 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 368 of file beast_PropertyStream.cpp.

Member Data Documentation

◆ m_name

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

privateinherited

Definition at line 312 of file PropertyStream.h.

◆ lock_

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

privateinherited

Definition at line 313 of file PropertyStream.h.

◆ item_

Item beast::PropertyStream::Source::item_

privateinherited

Definition at line 314 of file PropertyStream.h.

◆ parent_

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

privateinherited

Definition at line 315 of file PropertyStream.h.

◆ children_

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

privateinherited

Definition at line 316 of file PropertyStream.h.

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MutexType

Constructor & Destructor Documentation

◆ Application()

◆ ~Application()

Member Function Documentation

◆ getMasterMutex()

◆ setup()

◆ start()

◆ run()

◆ signalStop()

◆ checkSigs() [1/2]

◆ checkSigs() [2/2]

◆ isStopping()

◆ instanceID()

◆ logs()

◆ config()

◆ getIOContext()

◆ getCollectorManager()

◆ getNodeFamily()

◆ timeKeeper()

◆ getJobQueue()

◆ getTempNodeCache()

◆ cachedSLEs()

◆ getAmendmentTable()

◆ getHashRouter()

◆ getFeeTrack()

◆ getLoadManager()

◆ overlay()

◆ getTxQ()

◆ validators()

◆ validatorSites()

◆ validatorManifests()

◆ publisherManifests()

◆ cluster()

◆ peerReservations()

◆ getValidations()

◆ getNodeStore()

◆ getInboundLedgers()

◆ getInboundTransactions()

◆ getAcceptedLedgerCache()

◆ getLedgerMaster()

◆ getLedgerCleaner()

◆ getLedgerReplayer()

◆ getOPs()

◆ getOrderBookDB()

◆ getServerHandler()

◆ getMasterTransaction()

◆ getPerfLog()

◆ nodeIdentity()

◆ getValidationPublicKey()

◆ getResourceManager()

◆ getPathRequests()

◆ getSHAMapStore()

◆ pendingSaves()

◆ openLedger() [1/2]

◆ openLedger() [2/2]

◆ getRelationalDatabase()

◆ getIOLatency()

◆ serverOkay()

◆ journal()

◆ fdRequired()

◆ getWalletDB()

◆ getMaxDisallowedLedger()

◆ trapTxID()

◆ name()

◆ add() [1/2]

◆ add() [2/2]

◆ remove()

◆ removeAll()

◆ write_one()

◆ write() [1/2]

◆ write() [2/2]

◆ find()

◆ find_one_deep()