#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 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 std::uint64_t	instanceID () const =0
	Returns a 64-bit instance identifier, generated at startup.

virtual Config &	config ()=0

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

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

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

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

virtual int	fdRequired () const =0

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

virtual size_t	getNumberOfThreads () const =0
	Returns the number of io_context (I/O worker) threads used by the application.

virtual CollectorManager &	getCollectorManager ()=0

virtual Family &	getNodeFamily ()=0

virtual TimeKeeper &	getTimeKeeper ()=0

virtual JobQueue &	getJobQueue ()=0

virtual NodeCache &	getTempNodeCache ()=0

virtual CachedSLEs &	getCachedSLEs ()=0

virtual NetworkIDService &	getNetworkIDService ()=0

virtual AmendmentTable &	getAmendmentTable ()=0

virtual HashRouter &	getHashRouter ()=0

virtual LoadFeeTrack &	getFeeTrack ()=0

virtual LoadManager &	getLoadManager ()=0

virtual RCLValidations &	getValidations ()=0

virtual ValidatorList &	getValidators ()=0

virtual ValidatorSite &	getValidatorSites ()=0

virtual ManifestCache &	getValidatorManifests ()=0

virtual ManifestCache &	getPublisherManifests ()=0

virtual Overlay &	getOverlay ()=0

virtual Cluster &	getCluster ()=0

virtual PeerReservationTable &	getPeerReservations ()=0

virtual Resource::Manager &	getResourceManager ()=0

virtual NodeStore::Database &	getNodeStore ()=0

virtual SHAMapStore &	getSHAMapStore ()=0

virtual RelationalDatabase &	getRelationalDatabase ()=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 PendingSaves &	getPendingSaves ()=0

virtual OpenLedger &	getOpenLedger ()=0

virtual OpenLedger const &	getOpenLedger () const =0

virtual NetworkOPs &	getOPs ()=0

virtual OrderBookDB &	getOrderBookDB ()=0

virtual TransactionMaster &	getMasterTransaction ()=0

virtual TxQ &	getTxQ ()=0

virtual PathRequestManager &	getPathRequestManager ()=0

virtual ServerHandler &	getServerHandler ()=0

virtual perf::PerfLog &	getPerfLog ()=0

virtual bool	isStopping () const =0

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

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

virtual Logs &	getLogs ()=0

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

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

virtual Application &	getApp ()=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_ {nullptr}

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 2118 of file Application.cpp.

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.

◆ instanceID()

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

pure virtual

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

Implemented in xrpl::ApplicationImp.

◆ config()

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

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.

◆ 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.

◆ fdRequired()

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

pure virtual

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.

◆ getNumberOfThreads()

virtual size_t xrpl::Application::getNumberOfThreads ( ) const

pure virtual

Returns the number of io_context (I/O worker) threads used by the application.

Implemented in xrpl::ApplicationImp.

◆ getCollectorManager()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getNodeFamily()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getTimeKeeper()

virtual TimeKeeper & xrpl::ServiceRegistry::getTimeKeeper ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getJobQueue()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getTempNodeCache()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getCachedSLEs()

virtual CachedSLEs & xrpl::ServiceRegistry::getCachedSLEs ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getNetworkIDService()

virtual NetworkIDService & xrpl::ServiceRegistry::getNetworkIDService ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getAmendmentTable()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getHashRouter()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getFeeTrack()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getLoadManager()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getValidations()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getValidators()

virtual ValidatorList & xrpl::ServiceRegistry::getValidators ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getValidatorSites()

virtual ValidatorSite & xrpl::ServiceRegistry::getValidatorSites ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getValidatorManifests()

virtual ManifestCache & xrpl::ServiceRegistry::getValidatorManifests ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getPublisherManifests()

virtual ManifestCache & xrpl::ServiceRegistry::getPublisherManifests ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getOverlay()

virtual Overlay & xrpl::ServiceRegistry::getOverlay ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getCluster()

virtual Cluster & xrpl::ServiceRegistry::getCluster ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getPeerReservations()

virtual PeerReservationTable & xrpl::ServiceRegistry::getPeerReservations ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getResourceManager()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getNodeStore()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getSHAMapStore()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getRelationalDatabase()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getInboundLedgers()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getInboundTransactions()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getAcceptedLedgerCache()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getLedgerMaster()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getLedgerCleaner()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getLedgerReplayer()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getPendingSaves()

virtual PendingSaves & xrpl::ServiceRegistry::getPendingSaves ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getOpenLedger() [1/2]

virtual OpenLedger & xrpl::ServiceRegistry::getOpenLedger ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getOpenLedger() [2/2]

virtual OpenLedger const & xrpl::ServiceRegistry::getOpenLedger ( ) const

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getOPs()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getOrderBookDB()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getMasterTransaction()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getTxQ()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getPathRequestManager()

virtual PathRequestManager & xrpl::ServiceRegistry::getPathRequestManager ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getServerHandler()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getPerfLog()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ isStopping()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getJournal()

virtual beast::Journal xrpl::ServiceRegistry::getJournal ( std::string const & name )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getIOContext()

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

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getLogs()

virtual Logs & xrpl::ServiceRegistry::getLogs ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getTrapTxID()

virtual std::optional< uint256 > const & xrpl::ServiceRegistry::getTrapTxID ( ) const

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ getWalletDB()

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

pure virtualinherited

Retrieve the "wallet database".

Implemented in xrpl::ApplicationImp.

◆ getApp()

virtual Application & xrpl::ServiceRegistry::getApp ( )

pure virtualinherited

Implemented in xrpl::ApplicationImp.

◆ 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.

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MutexType

Constructor & Destructor Documentation

◆ Application()

Member Function Documentation

◆ getMasterMutex()

◆ setup()

◆ start()

◆ run()

◆ signalStop()

◆ checkSigs() [1/2]

◆ checkSigs() [2/2]

◆ instanceID()

◆ config()

◆ nodeIdentity()

◆ getValidationPublicKey()

◆ getIOLatency()

◆ serverOkay()

◆ fdRequired()

◆ getMaxDisallowedLedger()

◆ getNumberOfThreads()

◆ getCollectorManager()

◆ getNodeFamily()

◆ getTimeKeeper()

◆ getJobQueue()

◆ getTempNodeCache()

◆ getCachedSLEs()

◆ getNetworkIDService()

◆ getAmendmentTable()

◆ getHashRouter()

◆ getFeeTrack()

◆ getLoadManager()

◆ getValidations()

◆ getValidators()

◆ getValidatorSites()

◆ getValidatorManifests()

◆ getPublisherManifests()

◆ getOverlay()

◆ getCluster()

◆ getPeerReservations()

◆ getResourceManager()

◆ getNodeStore()

◆ getSHAMapStore()

◆ getRelationalDatabase()

◆ getInboundLedgers()

◆ getInboundTransactions()

◆ getAcceptedLedgerCache()

◆ getLedgerMaster()

◆ getLedgerCleaner()

◆ getLedgerReplayer()

◆ getPendingSaves()

◆ getOpenLedger() [1/2]

◆ getOpenLedger() [2/2]

◆ getOPs()

◆ getOrderBookDB()

◆ getMasterTransaction()

◆ getTxQ()

◆ getPathRequestManager()

◆ getServerHandler()

◆ getPerfLog()

◆ isStopping()

◆ getJournal()

◆ getIOContext()

◆ getLogs()

◆ getTrapTxID()

◆ getWalletDB()

◆ getApp()

◆ name()

◆ add() [1/2]

◆ add() [2/2]

◆ remove()

◆ removeAll()

◆ write_one()

◆ write() [1/2]

◆ write() [2/2]