Maintains a set of IP addresses used for getting into the network. More...

#include <PeerfinderManager.h>

Inheritance diagram for xrpl::PeerFinder::Manager:

[legend]

Collaboration diagram for xrpl::PeerFinder::Manager:

[legend]

Public Member Functions
	~Manager () override=default
	Destroy the object.
virtual void	setConfig (Config const &config)=0
	Set the configuration for the manager.
virtual void	start ()=0
	Transition to the started state, synchronously.
virtual void	stop ()=0
	Transition to the stopped state, synchronously.
virtual Config	config ()=0
	Returns the configuration for the manager.
virtual void	addFixedPeer (std::string_view name, std::vector< beast::IP::Endpoint > const &addresses)=0
	Add a peer that should always be connected.
virtual void	addFallbackStrings (std::string const &name, std::vector< std::string > const &strings)=0
	Add a set of strings as fallback IP::Endpoint sources.
virtual std::pair< std::shared_ptr< Slot >, Result >	newInboundSlot (beast::IP::Endpoint const &localEndpoint, beast::IP::Endpoint const &remoteEndpoint)=0
	Add a URL as a fallback location to obtain IP::Endpoint sources.
virtual std::pair< std::shared_ptr< Slot >, Result >	newOutboundSlot (beast::IP::Endpoint const &remoteEndpoint)=0
	Create a new outbound slot with the specified remote endpoint.
virtual void	onEndpoints (std::shared_ptr< Slot > const &slot, Endpoints const &endpoints)=0
	Called when mtENDPOINTS is received.
virtual void	onClosed (std::shared_ptr< Slot > const &slot)=0
	Called when the slot is closed.
virtual void	onFailure (std::shared_ptr< Slot > const &slot)=0
	Called when an outbound connection is deemed to have failed.
virtual void	onRedirects (boost::asio::ip::tcp::endpoint const &remoteAddress, std::vector< boost::asio::ip::tcp::endpoint > const &eps)=0
	Called when we received redirect IPs from a busy peer.
virtual bool	onConnected (std::shared_ptr< Slot > const &slot, beast::IP::Endpoint const &localEndpoint)=0
	Called when an outbound connection attempt succeeds.
virtual Result	activate (std::shared_ptr< Slot > const &slot, PublicKey const &key, bool reserved)=0
	Request an active slot type.
virtual std::vector< Endpoint >	redirect (std::shared_ptr< Slot > const &slot)=0
	Returns a set of endpoints suitable for redirection.
virtual std::vector< beast::IP::Endpoint >	autoconnect ()=0
	Return a set of addresses we should connect to.
virtual std::vector< std::pair< std::shared_ptr< Slot >, std::vector< Endpoint > > >	buildEndpointsForPeers ()=0
virtual void	oncePerSecond ()=0
	Perform periodic activity.
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	writeOne (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 *	findOneDeep (std::string const &name)
PropertyStream::Source *	findPath (std::string path)
PropertyStream::Source *	findOne (std::string const &name)
virtual void	onWrite (Map &)
	Subclass override.

Static Public Member Functions
static bool	peelLeadingSlash (std::string *path)
static bool	peelTrailingSlashstar (std::string *path)
static std::string	peelName (std::string *path)

Protected Member Functions
	Manager () noexcept

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

Detailed Description

Maintains a set of IP addresses used for getting into the network.

Definition at line 165 of file PeerfinderManager.h.

Constructor & Destructor Documentation

◆ Manager()

xrpl::PeerFinder::Manager::Manager ( )

protectednoexcept

Definition at line 256 of file PeerfinderManager.cpp.

◆ ~Manager()

xrpl::PeerFinder::Manager::~Manager ( )

overridedefault

Destroy the object.

Any pending source fetch operations are aborted. There may be some listener calls made before the destructor returns.

Member Function Documentation

◆ setConfig()

virtual void xrpl::PeerFinder::Manager::setConfig ( Config const & config )

pure virtual

Set the configuration for the manager.

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

Implemented in xrpl::PeerFinder::ManagerImp.

◆ start()

virtual void xrpl::PeerFinder::Manager::start ( )

pure virtual

Transition to the started state, synchronously.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ stop()

virtual void xrpl::PeerFinder::Manager::stop ( )

pure virtual

Transition to the stopped state, synchronously.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ config()

virtual Config xrpl::PeerFinder::Manager::config ( )

pure virtual

Returns the configuration for the manager.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ addFixedPeer()

virtual void xrpl::PeerFinder::Manager::addFixedPeer	(	std::string_view	name,
		std::vector< beast::IP::Endpoint > const &	addresses )

pure virtual

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.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ addFallbackStrings()

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

pure virtual

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

Parameters

name	A label used for diagnostics.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ newInboundSlot()

virtual std::pair< std::shared_ptr< Slot >, Result > xrpl::PeerFinder::Manager::newInboundSlot	(	beast::IP::Endpoint const &	localEndpoint,
		beast::IP::Endpoint const &	remoteEndpoint )

pure virtual

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.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ newOutboundSlot()

virtual std::pair< std::shared_ptr< Slot >, Result > xrpl::PeerFinder::Manager::newOutboundSlot ( beast::IP::Endpoint const & remoteEndpoint )

pure virtual

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.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ onEndpoints()

virtual void xrpl::PeerFinder::Manager::onEndpoints	(	std::shared_ptr< Slot > const &	slot,
		Endpoints const &	endpoints )

pure virtual

Called when mtENDPOINTS is received.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ onClosed()

virtual void xrpl::PeerFinder::Manager::onClosed ( std::shared_ptr< Slot > const & slot )

pure virtual

Called when the slot is closed.

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

Implemented in xrpl::PeerFinder::ManagerImp.

◆ onFailure()

virtual void xrpl::PeerFinder::Manager::onFailure ( std::shared_ptr< Slot > const & slot )

pure virtual

Called when an outbound connection is deemed to have failed.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ onRedirects()

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

pure virtual

Called when we received redirect IPs from a busy peer.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ onConnected()

virtual bool xrpl::PeerFinder::Manager::onConnected	(	std::shared_ptr< Slot > const &	slot,
		beast::IP::Endpoint const &	localEndpoint )

pure virtual

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

Implemented in xrpl::PeerFinder::ManagerImp.

◆ activate()

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

pure virtual

Request an active slot type.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ redirect()

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

pure virtual

Returns a set of endpoints suitable for redirection.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ autoconnect()

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

pure virtual

Return a set of addresses we should connect to.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ buildEndpointsForPeers()

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

pure virtual

Implemented in xrpl::PeerFinder::ManagerImp.

◆ oncePerSecond()

virtual void xrpl::PeerFinder::Manager::oncePerSecond ( )

pure virtual

Perform periodic activity.

This should be called once per second.

Implemented in xrpl::PeerFinder::ManagerImp.

◆ name()

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

nodiscardinherited

Returns the name of this source.

Definition at line 168 of file beast_PropertyStream.cpp.

◆ add() [1/2]

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

inherited

Add a child source.

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

◆ removeAll()

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

inherited

Remove all child sources from this Source.

Definition at line 196 of file beast_PropertyStream.cpp.

◆ writeOne()

void beast::PropertyStream::Source::writeOne ( PropertyStream & stream )

inherited

Write only this Source to the stream.

Definition at line 209 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 216 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 228 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 246 of file beast_PropertyStream.cpp.

◆ findOneDeep()

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

inherited

Definition at line 317 of file beast_PropertyStream.cpp.

◆ findPath()

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

inherited

Definition at line 334 of file beast_PropertyStream.cpp.

◆ findOne()

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

inherited

Definition at line 352 of file beast_PropertyStream.cpp.

◆ peelLeadingSlash()

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

staticinherited

Definition at line 266 of file beast_PropertyStream.cpp.

◆ peelTrailingSlashstar()

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

staticinherited

Definition at line 277 of file beast_PropertyStream.cpp.

◆ peelName()

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

staticinherited

Definition at line 293 of file beast_PropertyStream.cpp.

◆ onWrite()

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

virtualinherited

Subclass override.

The default version does nothing.

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

Definition at line 364 of file beast_PropertyStream.cpp.

Member Data Documentation

◆ name_

std::string const beast::PropertyStream::Source::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 Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Manager()

◆ ~Manager()

Member Function Documentation

◆ setConfig()

◆ start()

◆ stop()

◆ config()

◆ addFixedPeer()

◆ addFallbackStrings()

◆ newInboundSlot()

◆ newOutboundSlot()

◆ onEndpoints()

◆ onClosed()

◆ onFailure()

◆ onRedirects()

◆ onConnected()

◆ activate()

◆ redirect()

◆ autoconnect()

◆ buildEndpointsForPeers()

◆ oncePerSecond()

◆ name()

◆ add() [1/2]

◆ add() [2/2]

◆ remove()

◆ removeAll()

◆ writeOne()

◆ write() [1/2]

◆ write() [2/2]

◆ find()

◆ findOneDeep()

◆ findPath()

◆ findOne()

◆ peelLeadingSlash()

◆ peelTrailingSlashstar()

◆ peelName()

◆ onWrite()

Member Data Documentation

◆ name_

◆ lock_

◆ item_

◆ parent_

◆ children_