ripple::Application Class Reference

#include <Application.h>

Inheritance diagram for ripple::Application:

Collaboration diagram for ripple::Application:

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 113 of file Application.h.

Member Typedef Documentation

MutexType

using ripple::Application::MutexType = std::recursive_mutex

Definition at line 127 of file Application.h.

Constructor & Destructor Documentation

Application()

ripple::Application::Application

(

)

Definition at line 2192 of file Application.cpp.

~Application()

virtual ripple::Application::~Application ( )

virtualdefault

Member Function Documentation

getMasterMutex()

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

pure virtual

Implemented in ripple::ApplicationImp.

setup()

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

pure virtual

Implemented in ripple::ApplicationImp.

start()

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

pure virtual

Implemented in ripple::ApplicationImp.

run()

virtual void ripple::Application::run ( )

pure virtual

Implemented in ripple::ApplicationImp.

signalStop()

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

pure virtual

Implemented in ripple::ApplicationImp.

checkSigs() [1/2]

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

pure virtual

Implemented in ripple::ApplicationImp.

checkSigs() [2/2]

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

pure virtual

Implemented in ripple::ApplicationImp.

isStopping()

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

pure virtual

Implemented in ripple::ApplicationImp.

instanceID()

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

pure virtual

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

Implemented in ripple::ApplicationImp.

logs()

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

pure virtual

Implemented in ripple::ApplicationImp.

config()

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

pure virtual

Implemented in ripple::ApplicationImp.

getIOContext()

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

pure virtual

Implemented in ripple::ApplicationImp.

getCollectorManager()

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

pure virtual

Implemented in ripple::ApplicationImp.

getNodeFamily()

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

pure virtual

Implemented in ripple::ApplicationImp.

timeKeeper()

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

pure virtual

Implemented in ripple::ApplicationImp.

getJobQueue()

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

pure virtual

Implemented in ripple::ApplicationImp.

getTempNodeCache()

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

pure virtual

Implemented in ripple::ApplicationImp.

cachedSLEs()

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

pure virtual

Implemented in ripple::ApplicationImp.

getAmendmentTable()

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

pure virtual

Implemented in ripple::ApplicationImp.

getHashRouter()

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

pure virtual

Implemented in ripple::ApplicationImp.

getFeeTrack()

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

pure virtual

Implemented in ripple::ApplicationImp.

getLoadManager()

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

pure virtual

Implemented in ripple::ApplicationImp.

overlay()

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

pure virtual

Implemented in ripple::ApplicationImp.

getTxQ()

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

pure virtual

Implemented in ripple::ApplicationImp.

validators()

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

pure virtual

Implemented in ripple::ApplicationImp.

validatorSites()

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

pure virtual

Implemented in ripple::ApplicationImp.

validatorManifests()

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

pure virtual

Implemented in ripple::ApplicationImp.

publisherManifests()

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

pure virtual

Implemented in ripple::ApplicationImp.

cluster()

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

pure virtual

Implemented in ripple::ApplicationImp.

peerReservations()

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

pure virtual

Implemented in ripple::ApplicationImp.

getValidations()

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

pure virtual

Implemented in ripple::ApplicationImp.

getNodeStore()

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

pure virtual

Implemented in ripple::ApplicationImp.

getInboundLedgers()

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

pure virtual

Implemented in ripple::ApplicationImp.

getInboundTransactions()

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

pure virtual

Implemented in ripple::ApplicationImp.

getAcceptedLedgerCache()

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

pure virtual

Implemented in ripple::ApplicationImp.

getLedgerMaster()

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

pure virtual

Implemented in ripple::ApplicationImp.

getLedgerCleaner()

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

pure virtual

Implemented in ripple::ApplicationImp.

getLedgerReplayer()

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

pure virtual

Implemented in ripple::ApplicationImp.

getOPs()

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

pure virtual

Implemented in ripple::ApplicationImp.

getOrderBookDB()

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

pure virtual

Implemented in ripple::ApplicationImp.

getServerHandler()

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

pure virtual

Implemented in ripple::ApplicationImp.

getMasterTransaction()

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

pure virtual

Implemented in ripple::ApplicationImp.

getPerfLog()

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

pure virtual

Implemented in ripple::ApplicationImp.

nodeIdentity()

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

pure virtual

Implemented in ripple::ApplicationImp.

getValidationPublicKey()

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

pure virtual

Implemented in ripple::ApplicationImp.

getResourceManager()

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

pure virtual

Implemented in ripple::ApplicationImp.

getPathRequests()

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

pure virtual

Implemented in ripple::ApplicationImp.

getSHAMapStore()

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

pure virtual

Implemented in ripple::ApplicationImp.

pendingSaves()

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

pure virtual

Implemented in ripple::ApplicationImp.

openLedger() [1/2]

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

pure virtual

Implemented in ripple::ApplicationImp.

openLedger() [2/2]

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

pure virtual

Implemented in ripple::ApplicationImp.

getRelationalDatabase()

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

pure virtual

Implemented in ripple::ApplicationImp.

getIOLatency()

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

pure virtual

Implemented in ripple::ApplicationImp.

serverOkay()

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

pure virtual

Implemented in ripple::ApplicationImp.

journal()

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

pure virtual

Implemented in ripple::ApplicationImp.

fdRequired()

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

pure virtual

Implemented in ripple::ApplicationImp.

getWalletDB()

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

pure virtual

Retrieve the "wallet database".

Implemented in ripple::ApplicationImp.

getMaxDisallowedLedger()

virtual LedgerIndex ripple::Application::getMaxDisallowedLedger ( )

pure virtual

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

Implemented in ripple::ApplicationImp.

trapTxID()

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

pure virtual

Implemented in ripple::ApplicationImp.

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.

onWrite()

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

virtualinherited

Subclass override.

The default version does nothing.

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

Definition at line 387 of file beast_PropertyStream.cpp.

Member Data Documentation

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.