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

Inheritance diagram for ripple::PeerFinder::Manager:

[legend]

Collaboration diagram for ripple::PeerFinder::Manager:

[legend]

Public Member Functions
virtual	~Manager ()=default
	Destroy the object. More...

virtual void	setConfig (Config const &config)=0
	Set the configuration for the manager. More...

virtual Config	config ()=0
	Returns the configuration for the manager. More...

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

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

virtual std::shared_ptr< Slot >	new_inbound_slot (beast::IP::Endpoint const &local_endpoint, beast::IP::Endpoint const &remote_endpoint)=0
	Add a URL as a fallback location to obtain IP::Endpoint sources. More...

virtual std::shared_ptr< Slot >	new_outbound_slot (beast::IP::Endpoint const &remote_endpoint)=0
	Create a new outbound slot with the specified remote endpoint. More...

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

virtual void	on_closed (std::shared_ptr< Slot > const &slot)=0
	Called when the slot is closed. More...

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

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

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

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

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

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

virtual std::vector< std::pair< std::shared_ptr< Slot >, std::vector< Endpoint > > >	buildEndpointsForPeers ()=0

virtual void	once_per_second ()=0
	Perform periodic activity. More...

RootStoppable &	getRoot ()

void	setParent (Stoppable &parent)
	Set the parent of this Stoppable. More...

bool	isStopping () const
	Returns `true` if the stoppable should stop. More...

bool	isStopped () const
	Returns `true` if the requested stop has completed. More...

bool	areChildrenStopped () const
	Returns `true` if all children have stopped. More...

JobCounter &	jobCounter ()

bool	alertable_sleep_until (std::chrono::system_clock::time_point const &t)
	Sleep or wake up on stop. More...

std::string const &	name () const
	Returns the name of this source. More...

void	add (Source &source)
	Add a child source. More...

template<class Derived >
Derived *	add (Derived *child)
	Add a child source by pointer. More...

void	remove (Source &child)
	Remove a child source from this Source. More...

void	removeAll ()
	Remove all child sources from this Source. More...

void	write_one (PropertyStream &stream)
	Write only this Source to the stream. More...

void	write (PropertyStream &stream)
	write this source and all its children recursively to the stream. More...

void	write (PropertyStream &stream, std::string const &path)
	Parse the path and write the corresponding Source and optional children. More...

std::pair< Source *, bool >	find (std::string path)
	Parse the dot-delimited Source path and return the result. More...

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

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)

Protected Member Functions
	Manager (Stoppable &parent)

void	stopped ()
	Called by derived classes to indicate that the stoppable has stopped. More...

Private Types
using	Children = beast::LockFreeStack< Child >

Private Member Functions
virtual void	onPrepare ()
	Override called during preparation. More...

virtual void	onStart ()
	Override called during start. More...

virtual void	onStop ()
	Override called when the stop notification is issued. More...

virtual void	onChildrenStopped ()
	Override called when all children have stopped. More...

void	prepareRecursive ()

void	startRecursive ()

void	stopAsyncRecursive (beast::Journal j)

void	stopRecursive (beast::Journal j)

Private Attributes
std::string	m_name

RootStoppable &	m_root

Child	m_child

std::atomic< bool >	m_stopped {false}

std::atomic< bool >	m_childrenStopped {false}

Children	m_children

std::condition_variable	m_cv

std::mutex	m_mut

bool	m_is_stopping = false

bool	hasParent_ {false}

std::recursive_mutex	lock_

Item	item_

Source *	parent_

List< Item >	children_

Detailed Description

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

Definition at line 136 of file PeerfinderManager.h.

Member Typedef Documentation

◆ Children

using ripple::Stoppable::Children = beast::LockFreeStack<Child>

privateinherited

Definition at line 319 of file Stoppable.h.

Constructor & Destructor Documentation

◆ Manager()

ripple::PeerFinder::Manager::Manager ( Stoppable & parent )

explicitprotected

Definition at line 288 of file PeerfinderManager.cpp.

◆ ~Manager()

virtual ripple::PeerFinder::Manager::~Manager ( )

virtualdefault

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 ripple::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 ripple::PeerFinder::ManagerImp.

◆ config()

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

pure virtual

Returns the configuration for the manager.

Implemented in ripple::PeerFinder::ManagerImp.

◆ addFixedPeer()

virtual void ripple::PeerFinder::Manager::addFixedPeer	(	std::string const &	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 ripple::PeerFinder::ManagerImp.

◆ addFallbackStrings()

virtual void ripple::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 ripple::PeerFinder::ManagerImp.

◆ new_inbound_slot()

virtual std::shared_ptr<Slot> ripple::PeerFinder::Manager::new_inbound_slot	(	beast::IP::Endpoint const &	local_endpoint,
		beast::IP::Endpoint const &	remote_endpoint
	)

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 ripple::PeerFinder::ManagerImp.

◆ new_outbound_slot()

virtual std::shared_ptr<Slot> ripple::PeerFinder::Manager::new_outbound_slot ( beast::IP::Endpoint const & remote_endpoint )

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 ripple::PeerFinder::ManagerImp.

◆ on_endpoints()

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

pure virtual

Called when mtENDPOINTS is received.

Implemented in ripple::PeerFinder::ManagerImp.

◆ on_closed()

virtual void ripple::PeerFinder::Manager::on_closed ( 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 ripple::PeerFinder::ManagerImp.

◆ on_failure()

virtual void ripple::PeerFinder::Manager::on_failure ( std::shared_ptr< Slot > const & slot )

pure virtual

Called when an outbound connection is deemed to have failed.

Implemented in ripple::PeerFinder::ManagerImp.

◆ onRedirects()

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

pure virtual

Called when we received redirect IPs from a busy peer.

Implemented in ripple::PeerFinder::ManagerImp.

◆ onConnected()

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

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 ripple::PeerFinder::ManagerImp.

◆ activate()

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

pure virtual

Request an active slot type.

Implemented in ripple::PeerFinder::ManagerImp.

◆ redirect()

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

pure virtual

Returns a set of endpoints suitable for redirection.

Implemented in ripple::PeerFinder::ManagerImp.

◆ autoconnect()

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

pure virtual

Return a set of addresses we should connect to.

Implemented in ripple::PeerFinder::ManagerImp.

◆ buildEndpointsForPeers()

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

pure virtual

Implemented in ripple::PeerFinder::ManagerImp.

◆ once_per_second()

virtual void ripple::PeerFinder::Manager::once_per_second ( )

pure virtual

Perform periodic activity.

This should be called once per second.

Implemented in ripple::PeerFinder::ManagerImp.

◆ getRoot()

RootStoppable& ripple::Stoppable::getRoot ( )

inherited

Definition at line 214 of file Stoppable.h.

◆ setParent()

void ripple::Stoppable::setParent ( Stoppable & parent )

inherited

Set the parent of this Stoppable.

Note: The Stoppable must not already have a parent. The parent to be set cannot not be stopping. Both roots must match.

Definition at line 43 of file Stoppable.cpp.

◆ isStopping()

bool ripple::Stoppable::isStopping ( ) const

inherited

Returns true if the stoppable should stop.

Definition at line 54 of file Stoppable.cpp.

◆ isStopped()

bool ripple::Stoppable::isStopped ( ) const

inherited

Returns true if the requested stop has completed.

Definition at line 60 of file Stoppable.cpp.

◆ areChildrenStopped()

bool ripple::Stoppable::areChildrenStopped ( ) const

inherited

Returns true if all children have stopped.

Definition at line 66 of file Stoppable.cpp.

◆ jobCounter()

JobCounter & ripple::Stoppable::jobCounter ( )

inherited

Definition at line 437 of file Stoppable.h.

◆ alertable_sleep_until()

bool ripple::Stoppable::alertable_sleep_until ( std::chrono::system_clock::time_point const & t )

inherited

Sleep or wake up on stop.

Returns: true if we are stopping

Definition at line 455 of file Stoppable.h.

◆ stopped()

void ripple::Stoppable::stopped ( )

protectedinherited

Called by derived classes to indicate that the stoppable has stopped.

Definition at line 72 of file Stoppable.cpp.

◆ onPrepare()

void ripple::Stoppable::onPrepare ( )

privatevirtualinherited

Override called during preparation.

Since all other Stoppable objects in the tree have already been constructed, this provides an opportunity to perform initialization which depends on calling into other Stoppable objects. This call is made on the same thread that called prepare(). The default implementation does nothing. Guaranteed to only be called once.

Definition at line 80 of file Stoppable.cpp.

◆ onStart()

void ripple::Stoppable::onStart ( )

privatevirtualinherited

◆ onStop()

void ripple::Stoppable::onStop ( )

privatevirtualinherited

Override called when the stop notification is issued.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation simply calls stopped(). This is applicable when the Stoppable has a trivial stop operation (or no stop operation), and we are merely using the Stoppable API to position it as a dependency of some parent service.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Definition at line 90 of file Stoppable.cpp.

◆ onChildrenStopped()

void ripple::Stoppable::onChildrenStopped ( )

privatevirtualinherited

Override called when all children have stopped.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation does nothing.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Definition at line 96 of file Stoppable.cpp.

◆ prepareRecursive()

void ripple::Stoppable::prepareRecursive ( )

privateinherited

Definition at line 103 of file Stoppable.cpp.

◆ startRecursive()

void ripple::Stoppable::startRecursive ( )

privateinherited

Definition at line 113 of file Stoppable.cpp.

◆ stopAsyncRecursive()

void ripple::Stoppable::stopAsyncRecursive ( beast::Journal j )

privateinherited

Definition at line 123 of file Stoppable.cpp.

◆ stopRecursive()

void ripple::Stoppable::stopRecursive ( beast::Journal j )

privateinherited

Definition at line 134 of file Stoppable.cpp.

◆ name()

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

inherited

Returns the name of this source.

Definition at line 190 of file beast_PropertyStream.cpp.

◆ add() [1/2]

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

inherited

Add a child source.

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

◆ remove()

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

inherited

Remove a child source from this Source.

Definition at line 208 of file beast_PropertyStream.cpp.

◆ removeAll()

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

inherited

Remove all child sources from this Source.

Definition at line 220 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 233 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 240 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 252 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 266 of file beast_PropertyStream.cpp.

◆ find_one_deep()

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

inherited

Definition at line 333 of file beast_PropertyStream.cpp.

◆ find_path()

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

inherited

Definition at line 350 of file beast_PropertyStream.cpp.

◆ find_one()

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

inherited

Definition at line 368 of file beast_PropertyStream.cpp.

◆ peel_leading_slash()

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

staticinherited

Definition at line 286 of file beast_PropertyStream.cpp.

◆ peel_trailing_slashstar()

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

staticinherited

Definition at line 297 of file beast_PropertyStream.cpp.

◆ peel_name()

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

staticinherited

Definition at line 313 of file beast_PropertyStream.cpp.

◆ onWrite()

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

virtualinherited

Subclass override.

The default version does nothing.

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

Definition at line 380 of file beast_PropertyStream.cpp.

Member Data Documentation

◆ m_name

std::string ripple::Stoppable::m_name

privateinherited

Definition at line 339 of file Stoppable.h.

◆ m_root

RootStoppable& ripple::Stoppable::m_root

privateinherited

Definition at line 340 of file Stoppable.h.

◆ m_child

Child ripple::Stoppable::m_child

privateinherited

Definition at line 341 of file Stoppable.h.

◆ m_stopped

std::atomic<bool> ripple::Stoppable::m_stopped {false}

privateinherited

Definition at line 342 of file Stoppable.h.

◆ m_childrenStopped

std::atomic<bool> ripple::Stoppable::m_childrenStopped {false}

privateinherited

Definition at line 343 of file Stoppable.h.

◆ m_children

Children ripple::Stoppable::m_children

privateinherited

Definition at line 344 of file Stoppable.h.

◆ m_cv

std::condition_variable ripple::Stoppable::m_cv

privateinherited

Definition at line 345 of file Stoppable.h.

◆ m_mut

std::mutex ripple::Stoppable::m_mut

privateinherited

Definition at line 346 of file Stoppable.h.

◆ m_is_stopping

bool ripple::Stoppable::m_is_stopping = false

privateinherited

Definition at line 347 of file Stoppable.h.

◆ hasParent_

bool ripple::Stoppable::hasParent_ {false}

privateinherited

Definition at line 348 of file Stoppable.h.

◆ lock_

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

privateinherited

Definition at line 346 of file PropertyStream.h.

◆ item_

Item beast::PropertyStream::Source::item_

privateinherited

Definition at line 347 of file PropertyStream.h.

◆ parent_

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

privateinherited

Definition at line 348 of file PropertyStream.h.

◆ children_

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

privateinherited

Definition at line 349 of file PropertyStream.h.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Children

Constructor & Destructor Documentation

◆ Manager()

◆ ~Manager()

Member Function Documentation

◆ setConfig()

◆ config()

◆ addFixedPeer()

◆ addFallbackStrings()

◆ new_inbound_slot()

◆ new_outbound_slot()

◆ on_endpoints()

◆ on_closed()

◆ on_failure()

◆ onRedirects()

◆ onConnected()

◆ activate()

◆ redirect()

◆ autoconnect()

◆ buildEndpointsForPeers()

◆ once_per_second()

◆ getRoot()

◆ setParent()

◆ isStopping()

◆ isStopped()

◆ areChildrenStopped()

◆ jobCounter()

◆ alertable_sleep_until()

◆ stopped()

◆ onPrepare()

◆ onStart()

◆ onStop()

◆ onChildrenStopped()

◆ prepareRecursive()

◆ startRecursive()

◆ stopAsyncRecursive()

◆ stopRecursive()

◆ 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()

◆ onWrite()

Member Data Documentation

◆ m_name

◆ m_root

◆ m_child

◆ m_stopped

◆ m_childrenStopped

◆ m_children

◆ m_cv

◆ m_mut

◆ m_is_stopping

◆ hasParent_

◆ lock_

◆ item_

◆ parent_

◆ children_