Inheritance diagram for xrpl::PeerFinder::ManagerImp:

[legend]

Collaboration diagram for xrpl::PeerFinder::ManagerImp:

[legend]

Classes
struct	Stats

Public Member Functions
	ManagerImp (boost::asio::io_context &io_context, clock_type &clock, beast::Journal journal, BasicConfig const &config, beast::insight::Collector::ptr const &collector)

	~ManagerImp () override

void	stop () override
	Transition to the stopped state, synchronously.

void	setConfig (Config const &config) override
	Set the configuration for the manager.

Config	config () override
	Returns the configuration for the manager.

void	addFixedPeer (std::string const &name, std::vector< beast::IP::Endpoint > const &addresses) override
	Add a peer that should always be connected.

void	addFallbackStrings (std::string const &name, std::vector< std::string > const &strings) override
	Add a set of strings as fallback IP::Endpoint sources.

void	addFallbackURL (std::string const &name, std::string const &url)

std::pair< std::shared_ptr< Slot >, Result >	new_inbound_slot (beast::IP::Endpoint const &local_endpoint, beast::IP::Endpoint const &remote_endpoint) override
	Add a URL as a fallback location to obtain IP::Endpoint sources.

std::pair< std::shared_ptr< Slot >, Result >	new_outbound_slot (beast::IP::Endpoint const &remote_endpoint) override
	Create a new outbound slot with the specified remote endpoint.

void	on_endpoints (std::shared_ptr< Slot > const &slot, Endpoints const &endpoints) override
	Called when mtENDPOINTS is received.

void	on_closed (std::shared_ptr< Slot > const &slot) override
	Called when the slot is closed.

void	on_failure (std::shared_ptr< Slot > const &slot) override
	Called when an outbound connection is deemed to have failed.

void	onRedirects (boost::asio::ip::tcp::endpoint const &remote_address, std::vector< boost::asio::ip::tcp::endpoint > const &eps) override
	Called when we received redirect IPs from a busy peer.

bool	onConnected (std::shared_ptr< Slot > const &slot, beast::IP::Endpoint const &local_endpoint) override
	Called when an outbound connection attempt succeeds.

Result	activate (std::shared_ptr< Slot > const &slot, PublicKey const &key, bool reserved) override
	Request an active slot type.

std::vector< Endpoint >	redirect (std::shared_ptr< Slot > const &slot) override
	Returns a set of endpoints suitable for redirection.

std::vector< beast::IP::Endpoint >	autoconnect () override
	Return a set of addresses we should connect to.

void	once_per_second () override
	Perform periodic activity.

std::vector< std::pair< std::shared_ptr< Slot >, std::vector< Endpoint > > >	buildEndpointsForPeers () override

void	start () override
	Transition to the started state, synchronously.

void	onWrite (beast::PropertyStream::Map &map) override
	Subclass override.

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)

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)

Public Attributes
boost::asio::io_context &	io_context_

std::optional< boost::asio::executor_work_guard< boost::asio::io_context::executor_type > >	work_

clock_type &	m_clock

beast::Journal	m_journal

StoreSqdb	m_store

Checker< boost::asio::ip::tcp >	checker_

Logic< decltype(checker_)>	m_logic

BasicConfig const &	m_config

Private Member Functions
void	collect_metrics ()

Private Attributes
std::mutex	m_statsMutex

Stats	m_stats

std::string const	m_name

std::recursive_mutex	lock_

Item	item_

Source *	parent_ {nullptr}

List< Item >	children_

Detailed Description

Definition at line 16 of file PeerfinderManager.cpp.

Constructor & Destructor Documentation

◆ ManagerImp()

xrpl::PeerFinder::ManagerImp::ManagerImp	(	boost::asio::io_context &	io_context,
		clock_type &	clock,
		beast::Journal	journal,
		BasicConfig const &	config,
		beast::insight::Collector::ptr const &	collector
	)

Definition at line 30 of file PeerfinderManager.cpp.

◆ ~ManagerImp()

xrpl::PeerFinder::ManagerImp::~ManagerImp ( )

override

Definition at line 48 of file PeerfinderManager.cpp.

Member Function Documentation

◆ stop()

void xrpl::PeerFinder::ManagerImp::stop ( )

overridevirtual

Transition to the stopped state, synchronously.

Implements xrpl::PeerFinder::Manager.

Definition at line 54 of file PeerfinderManager.cpp.

◆ setConfig()

void xrpl::PeerFinder::ManagerImp::setConfig ( Config const & config )

overridevirtual

Set the configuration for the manager.

The new settings will be applied asynchronously. Thread safety: Can be called from any threads at any time.

Implements xrpl::PeerFinder::Manager.

Definition at line 71 of file PeerfinderManager.cpp.

◆ config()

Config xrpl::PeerFinder::ManagerImp::config ( )

overridevirtual

Returns the configuration for the manager.

Implements xrpl::PeerFinder::Manager.

Definition at line 77 of file PeerfinderManager.cpp.

◆ addFixedPeer()

void xrpl::PeerFinder::ManagerImp::addFixedPeer	(	std::string const &	name,
		std::vector< beast::IP::Endpoint > const &	addresses
	)

overridevirtual

Add a peer that should always be connected.

This is useful for maintaining a private cluster of peers. The string is the name as specified in the configuration file, along with the set of corresponding IP addresses.

Implements xrpl::PeerFinder::Manager.

Definition at line 83 of file PeerfinderManager.cpp.

◆ addFallbackStrings()

void xrpl::PeerFinder::ManagerImp::addFallbackStrings	(	std::string const &	name,
		std::vector< std::string > const &	strings
	)

overridevirtual

Add a set of strings as fallback IP::Endpoint sources.

Parameters

name	A label used for diagnostics.

Implements xrpl::PeerFinder::Manager.

Definition at line 90 of file PeerfinderManager.cpp.

◆ addFallbackURL()

void xrpl::PeerFinder::ManagerImp::addFallbackURL	(	std::string const &	name,
		std::string const &	url
	)

Definition at line 96 of file PeerfinderManager.cpp.

◆ new_inbound_slot()

std::pair< std::shared_ptr< Slot >, Result > xrpl::PeerFinder::ManagerImp::new_inbound_slot	(	beast::IP::Endpoint const &	local_endpoint,
		beast::IP::Endpoint const &	remote_endpoint
	)

overridevirtual

Add a URL as a fallback location to obtain IP::Endpoint sources.

Parameters

name	A label used for diagnostics. Create a new inbound slot with the specified remote endpoint. If nullptr is returned, then the slot could not be assigned. Usually this is because of a detected self-connection.

Implements xrpl::PeerFinder::Manager.

Definition at line 104 of file PeerfinderManager.cpp.

◆ new_outbound_slot()

std::pair< std::shared_ptr< Slot >, Result > xrpl::PeerFinder::ManagerImp::new_outbound_slot ( beast::IP::Endpoint const & remote_endpoint )

overridevirtual

Create a new outbound slot with the specified remote endpoint.

If nullptr is returned, then the slot could not be assigned. Usually this is because of a duplicate connection.

Implements xrpl::PeerFinder::Manager.

Definition at line 112 of file PeerfinderManager.cpp.

◆ on_endpoints()

void xrpl::PeerFinder::ManagerImp::on_endpoints	(	std::shared_ptr< Slot > const &	slot,
		Endpoints const &	endpoints
	)

overridevirtual

Called when mtENDPOINTS is received.

Implements xrpl::PeerFinder::Manager.

Definition at line 118 of file PeerfinderManager.cpp.

◆ on_closed()

void xrpl::PeerFinder::ManagerImp::on_closed ( std::shared_ptr< Slot > const & slot )

overridevirtual

Called when the slot is closed.

This always happens when the socket is closed, unless the socket was canceled.

Implements xrpl::PeerFinder::Manager.

Definition at line 125 of file PeerfinderManager.cpp.

◆ on_failure()

void xrpl::PeerFinder::ManagerImp::on_failure ( std::shared_ptr< Slot > const & slot )

overridevirtual

Called when an outbound connection is deemed to have failed.

Implements xrpl::PeerFinder::Manager.

Definition at line 132 of file PeerfinderManager.cpp.

◆ onRedirects()

void xrpl::PeerFinder::ManagerImp::onRedirects	(	boost::asio::ip::tcp::endpoint const &	remote_address,
		std::vector< boost::asio::ip::tcp::endpoint > const &	eps
	)

overridevirtual

Called when we received redirect IPs from a busy peer.

Implements xrpl::PeerFinder::Manager.

Definition at line 139 of file PeerfinderManager.cpp.

◆ onConnected()

bool xrpl::PeerFinder::ManagerImp::onConnected	(	std::shared_ptr< Slot > const &	slot,
		beast::IP::Endpoint const &	local_endpoint
	)

overridevirtual

Called when an outbound connection attempt succeeds.

The local endpoint must be valid. If the caller receives an error when retrieving the local endpoint from the socket, it should proceed as if the connection attempt failed by calling on_closed instead of on_connected.

Returns: true if the connection should be kept

Implements xrpl::PeerFinder::Manager.

Definition at line 149 of file PeerfinderManager.cpp.

◆ activate()

Result xrpl::PeerFinder::ManagerImp::activate	(	std::shared_ptr< Slot > const &	slot,
		PublicKey const &	key,
		bool	reserved
	)

overridevirtual

Request an active slot type.

Implements xrpl::PeerFinder::Manager.

Definition at line 157 of file PeerfinderManager.cpp.

◆ redirect()

std::vector< Endpoint > xrpl::PeerFinder::ManagerImp::redirect ( std::shared_ptr< Slot > const & slot )

overridevirtual

Returns a set of endpoints suitable for redirection.

Implements xrpl::PeerFinder::Manager.

Definition at line 164 of file PeerfinderManager.cpp.

◆ autoconnect()

std::vector< beast::IP::Endpoint > xrpl::PeerFinder::ManagerImp::autoconnect ( )

overridevirtual

Return a set of addresses we should connect to.

Implements xrpl::PeerFinder::Manager.

Definition at line 171 of file PeerfinderManager.cpp.

◆ once_per_second()

void xrpl::PeerFinder::ManagerImp::once_per_second ( )

overridevirtual

Perform periodic activity.

This should be called once per second.

Implements xrpl::PeerFinder::Manager.

Definition at line 177 of file PeerfinderManager.cpp.

◆ buildEndpointsForPeers()

std::vector< std::pair< std::shared_ptr< Slot >, std::vector< Endpoint > > > xrpl::PeerFinder::ManagerImp::buildEndpointsForPeers ( )

overridevirtual

Implements xrpl::PeerFinder::Manager.

Definition at line 183 of file PeerfinderManager.cpp.

◆ start()

void xrpl::PeerFinder::ManagerImp::start ( )

overridevirtual

Transition to the started state, synchronously.

Implements xrpl::PeerFinder::Manager.

Definition at line 189 of file PeerfinderManager.cpp.

◆ onWrite()

void xrpl::PeerFinder::ManagerImp::onWrite ( beast::PropertyStream::Map & )

overridevirtual

Subclass override.

The default version does nothing.

Reimplemented from beast::PropertyStream::Source.

Definition at line 202 of file PeerfinderManager.cpp.

◆ collect_metrics()

void xrpl::PeerFinder::ManagerImp::collect_metrics ( )

private

Definition at line 227 of file PeerfinderManager.cpp.

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

Member Data Documentation

◆ io_context_

boost::asio::io_context& xrpl::PeerFinder::ManagerImp::io_context_

Definition at line 19 of file PeerfinderManager.cpp.

◆ work_

std::optional<boost::asio::executor_work_guard<boost::asio::io_context::executor_type> > xrpl::PeerFinder::ManagerImp::work_

Definition at line 20 of file PeerfinderManager.cpp.

◆ m_clock

clock_type& xrpl::PeerFinder::ManagerImp::m_clock

Definition at line 21 of file PeerfinderManager.cpp.

◆ m_journal

beast::Journal xrpl::PeerFinder::ManagerImp::m_journal

Definition at line 22 of file PeerfinderManager.cpp.

◆ m_store

StoreSqdb xrpl::PeerFinder::ManagerImp::m_store

Definition at line 23 of file PeerfinderManager.cpp.

◆ checker_

Checker<boost::asio::ip::tcp> xrpl::PeerFinder::ManagerImp::checker_

Definition at line 24 of file PeerfinderManager.cpp.

◆ m_logic

Logic<decltype(checker_)> xrpl::PeerFinder::ManagerImp::m_logic

Definition at line 25 of file PeerfinderManager.cpp.

◆ m_config

BasicConfig const& xrpl::PeerFinder::ManagerImp::m_config

Definition at line 26 of file PeerfinderManager.cpp.

◆ m_statsMutex

std::mutex xrpl::PeerFinder::ManagerImp::m_statsMutex

private

Definition at line 223 of file PeerfinderManager.cpp.

◆ m_stats

Stats xrpl::PeerFinder::ManagerImp::m_stats

private

Definition at line 224 of file PeerfinderManager.cpp.

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

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ManagerImp()

◆ ~ManagerImp()

Member Function Documentation

◆ stop()

◆ setConfig()

◆ config()

◆ addFixedPeer()

◆ addFallbackStrings()

◆ addFallbackURL()

◆ new_inbound_slot()

◆ new_outbound_slot()

◆ on_endpoints()

◆ on_closed()

◆ on_failure()

◆ onRedirects()

◆ onConnected()

◆ activate()

◆ redirect()

◆ autoconnect()

◆ once_per_second()

◆ buildEndpointsForPeers()

◆ start()

◆ onWrite()

◆ collect_metrics()

◆ name()

◆ add() [1/2]

◆ add() [2/2]

◆ remove()

◆ removeAll()

◆ write_one()

◆ write() [1/2]

◆ write() [2/2]

◆ find()

◆ find_one_deep()

◆ find_path()

◆ find_one()

◆ peel_leading_slash()

◆ peel_trailing_slashstar()

◆ peel_name()

Member Data Documentation

◆ io_context_

◆ work_

◆ m_clock

◆ m_journal

◆ m_store

◆ checker_

◆ m_logic

◆ m_config

◆ m_statsMutex

◆ m_stats

◆ m_name

◆ lock_

◆ item_

◆ parent_

◆ children_