Inheritance diagram for ripple::OverlayImpl:

[legend]

Collaboration diagram for ripple::OverlayImpl:

[legend]

Classes
class	Child

struct	Stats

struct	Timer

struct	TrafficGauges

Public Types
enum	Promote { Promote::automatic, Promote::never, Promote::always }

using	PeerSequence = std::vector< std::shared_ptr< Peer > >

Public Member Functions
	OverlayImpl (Application &app, Setup const &setup, Stoppable &parent, ServerHandler &serverHandler, Resource::Manager &resourceManager, Resolver &resolver, boost::asio::io_service &io_service, BasicConfig const &config, beast::insight::Collector::ptr const &collector)

	~OverlayImpl ()

	OverlayImpl (OverlayImpl const &)=delete

OverlayImpl &	operator= (OverlayImpl const &)=delete

PeerFinder::Manager &	peerFinder ()

Resource::Manager &	resourceManager ()

ServerHandler &	serverHandler ()

Setup const &	setup () const

Handoff	onHandoff (std::unique_ptr< stream_type > &&bundle, http_request_type &&request, endpoint_type remote_endpoint) override
	Conditionally accept an incoming HTTP request. More...

void	connect (beast::IP::Endpoint const &remote_endpoint) override
	Establish a peer connection to the specified endpoint. More...

int	limit () override
	Returns the maximum number of peers we are configured to allow. More...

std::size_t	size () const override
	The number of active peers on the network Active peers are only those peers that have completed the handshake and are running the Ripple protocol. More...

Json::Value	json () override
	Return diagnostics on the status of all peers. More...

PeerSequence	getActivePeers () const override
	Returns a sequence representing the current list of peers. More...

void	checkTracking (std::uint32_t) override
	Calls the checkTracking function on each peer. More...

std::shared_ptr< Peer >	findPeerByShortID (Peer::id_t const &id) const override
	Returns the peer with the matching short id, or null. More...

std::shared_ptr< Peer >	findPeerByPublicKey (PublicKey const &pubKey) override
	Returns the peer with the matching public key, or null. More...

void	broadcast (protocol::TMProposeSet &m) override
	Broadcast a proposal. More...

void	broadcast (protocol::TMValidation &m) override
	Broadcast a validation. More...

std::set< Peer::id_t >	relay (protocol::TMProposeSet &m, uint256 const &uid, PublicKey const &validator) override
	Relay a proposal. More...

std::set< Peer::id_t >	relay (protocol::TMValidation &m, uint256 const &uid, PublicKey const &validator) override
	Relay a validation. More...

std::shared_ptr< Message >	getManifestsMessage ()

void	add_active (std::shared_ptr< PeerImp > const &peer)

void	remove (std::shared_ptr< PeerFinder::Slot > const &slot)

void	activate (std::shared_ptr< PeerImp > const &peer)
	Called when a peer has connected successfully This is called after the peer handshake has been completed and during peer activation. More...

void	onPeerDeactivate (Peer::id_t id)

template<class UnaryFunc >
void	for_each (UnaryFunc &&f) const

void	onManifests (std::shared_ptr< protocol::TMManifests > const &m, std::shared_ptr< PeerImp > const &from)

void	reportTraffic (TrafficCount::category cat, bool isInbound, int bytes)

void	incJqTransOverflow () override
	Increment and retrieve counter for transaction job queue overflows. More...

std::uint64_t	getJqTransOverflow () const override

void	incPeerDisconnect () override
	Increment and retrieve counters for total peer disconnects, and disconnects we initiate for excessive resource consumption. More...

std::uint64_t	getPeerDisconnect () const override

void	incPeerDisconnectCharges () override

std::uint64_t	getPeerDisconnectCharges () const override

boost::optional< std::uint32_t >	networkID () const override
	Returns the ID of the network this server is configured for, if any. More...

Json::Value	crawlShards (bool pubKey, std::uint32_t hops) override
	Returns information reported to the crawl shard RPC command. More...

void	lastLink (std::uint32_t id)
	Called when the last link from a peer chain is received. More...

void	updateSlotAndSquelch (uint256 const &key, PublicKey const &validator, std::set< Peer::id_t > &&peers, protocol::MessageType type)
	Updates message count for validator/peer. More...

void	updateSlotAndSquelch (uint256 const &key, PublicKey const &validator, Peer::id_t peer, protocol::MessageType type)
	Overload to reduce allocation in case of single peer. More...

void	deletePeer (Peer::id_t id)
	Called when the peer is deleted. More...

template<class Function >
void	foreach (Function f) const
	Visit every active peer. 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)

Static Public Member Functions
static bool	isPeerUpgrade (http_request_type const &request)

template<class Body >
static bool	isPeerUpgrade (boost::beast::http::response< Body > const &response)

template<class Fields >
static bool	is_upgrade (boost::beast::http::header< true, Fields > const &req)

template<class Fields >
static bool	is_upgrade (boost::beast::http::header< false, Fields > const &req)

static std::string	makePrefix (std::uint32_t id)

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 Types
using	stream_type = boost::beast::ssl_stream< socket_type >

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

Private Types
using	clock_type = std::chrono::steady_clock

using	socket_type = boost::asio::ip::tcp::socket

using	address_type = boost::asio::ip::address

using	endpoint_type = boost::asio::ip::tcp::endpoint

using	error_code = boost::system::error_code

using	Children = beast::LockFreeStack< Child >

Private Member Functions
void	squelch (PublicKey const &validator, Peer::id_t const id, std::uint32_t squelchDuration) const override
	Squelch handler. More...

void	unsquelch (PublicKey const &validator, Peer::id_t id) const override
	Unsquelch handler. More...

std::shared_ptr< Writer >	makeRedirectResponse (std::shared_ptr< PeerFinder::Slot > const &slot, http_request_type const &request, address_type remote_address)

std::shared_ptr< Writer >	makeErrorResponse (std::shared_ptr< PeerFinder::Slot > const &slot, http_request_type const &request, address_type remote_address, std::string msg)

bool	processCrawl (http_request_type const &req, Handoff &handoff)
	Handles crawl requests. More...

bool	processValidatorList (http_request_type const &req, Handoff &handoff)
	Handles validator list requests. More...

bool	processHealth (http_request_type const &req, Handoff &handoff)
	Handles health requests. More...

bool	processRequest (http_request_type const &req, Handoff &handoff)
	Handles non-peer protocol requests. More...

Json::Value	getOverlayInfo ()
	Returns information about peers on the overlay network. More...

Json::Value	getServerInfo ()
	Returns information about the local server. More...

Json::Value	getServerCounts ()
	Returns information about the local server's performance counters. More...

Json::Value	getUnlInfo ()
	Returns information about the local server's UNL. More...

void	checkStopped ()

void	onPrepare () override
	Override called during preparation. More...

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

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

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

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

void	remove (Child &child)

void	stop ()

void	autoConnect ()

void	sendEndpoints ()

void	deleteIdlePeers ()
	Check if peers stopped relaying messages and if slots stopped receiving messages from the validator. More...

void	collect_metrics ()

void	prepareRecursive ()

void	startRecursive ()

void	stopAsyncRecursive (beast::Journal j)

void	stopRecursive (beast::Journal j)

Private Attributes
Application &	app_

boost::asio::io_service &	io_service_

boost::optional< boost::asio::io_service::work >	work_

boost::asio::io_service::strand	strand_

std::recursive_mutex	mutex_

std::condition_variable_any	cond_

std::weak_ptr< Timer >	timer_

boost::container::flat_map< Child *, std::weak_ptr< Child > >	list_

Setup	setup_

const beast::Journal	journal_

ServerHandler &	serverHandler_

Resource::Manager &	m_resourceManager

std::unique_ptr< PeerFinder::Manager >	m_peerFinder

TrafficCount	m_traffic

hash_map< std::shared_ptr< PeerFinder::Slot >, std::weak_ptr< PeerImp > >	m_peers

hash_map< Peer::id_t, std::weak_ptr< PeerImp > >	ids_

Resolver &	m_resolver

std::atomic< Peer::id_t >	next_id_

int	timer_count_

std::atomic< uint64_t >	jqTransOverflow_ {0}

std::atomic< uint64_t >	peerDisconnects_ {0}

std::atomic< uint64_t >	peerDisconnectsCharges_ {0}

std::atomic< std::chrono::seconds >	csLast_ {std::chrono::seconds{0}}

std::mutex	csMutex_

std::condition_variable	csCV_

std::set< std::uint32_t >	csIDs_

boost::optional< std::uint32_t >	networkID_

squelch::Slots< UptimeClock >	slots_

std::shared_ptr< Message >	manifestMessage_

std::optional< std::uint32_t >	manifestListSeq_

std::mutex	manifestLock_

Stats	m_stats

std::mutex	m_statsMutex

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

Definition at line 57 of file OverlayImpl.h.

Member Typedef Documentation

◆ clock_type

using ripple::OverlayImpl::clock_type = std::chrono::steady_clock

private

Definition at line 75 of file OverlayImpl.h.

◆ socket_type

using ripple::OverlayImpl::socket_type = boost::asio::ip::tcp::socket

private

Definition at line 76 of file OverlayImpl.h.

◆ address_type

using ripple::OverlayImpl::address_type = boost::asio::ip::address

private

Definition at line 77 of file OverlayImpl.h.

◆ endpoint_type

using ripple::OverlayImpl::endpoint_type = boost::asio::ip::tcp::endpoint

private

Definition at line 78 of file OverlayImpl.h.

◆ error_code

using ripple::OverlayImpl::error_code = boost::system::error_code

private

Definition at line 79 of file OverlayImpl.h.

◆ stream_type

using ripple::Overlay::stream_type = boost::beast::ssl_stream<socket_type>

protectedinherited

Definition at line 56 of file Overlay.h.

◆ PeerSequence

using ripple::Overlay::PeerSequence = std::vector<std::shared_ptr<Peer> >

inherited

Definition at line 82 of file Overlay.h.

◆ Children

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

privateinherited

Definition at line 319 of file Stoppable.h.

Member Enumeration Documentation

◆ Promote

enum ripple::Overlay::Promote

stronginherited

Enumerator
automatic
never
always

Definition at line 68 of file Overlay.h.

Constructor & Destructor Documentation

◆ OverlayImpl() [1/2]

ripple::OverlayImpl::OverlayImpl	(	Application &	app,
		Setup const &	setup,
		Stoppable &	parent,
		ServerHandler &	serverHandler,
		Resource::Manager &	resourceManager,
		Resolver &	resolver,
		boost::asio::io_service &	io_service,
		BasicConfig const &	config,
		beast::insight::Collector::ptr const &	collector
	)

Definition at line 113 of file OverlayImpl.cpp.

◆ ~OverlayImpl()

ripple::OverlayImpl::~OverlayImpl ( )

Definition at line 161 of file OverlayImpl.cpp.

◆ OverlayImpl() [2/2]

ripple::OverlayImpl::OverlayImpl ( OverlayImpl const & )

delete

Member Function Documentation

◆ operator=()

OverlayImpl& ripple::OverlayImpl::operator= ( OverlayImpl const & )

delete

◆ peerFinder()

PeerFinder::Manager& ripple::OverlayImpl::peerFinder ( )

Definition at line 159 of file OverlayImpl.h.

◆ resourceManager()

Resource::Manager& ripple::OverlayImpl::resourceManager ( )

Definition at line 165 of file OverlayImpl.h.

◆ serverHandler()

ServerHandler& ripple::OverlayImpl::serverHandler ( )

Definition at line 171 of file OverlayImpl.h.

◆ setup()

Setup const& ripple::OverlayImpl::setup ( ) const

Definition at line 177 of file OverlayImpl.h.

◆ onHandoff()

Handoff ripple::OverlayImpl::onHandoff	(	std::unique_ptr< stream_type > &&	bundle,
		http_request_type &&	request,
		endpoint_type	remote_address
	)

overridevirtual

Conditionally accept an incoming HTTP request.

Implements ripple::Overlay.

Definition at line 175 of file OverlayImpl.cpp.

◆ connect()

void ripple::OverlayImpl::connect ( beast::IP::Endpoint const & address )

overridevirtual

Establish a peer connection to the specified endpoint.

The call returns immediately, the connection attempt is performed asynchronously.

Implements ripple::Overlay.

Definition at line 402 of file OverlayImpl.cpp.

◆ limit()

int ripple::OverlayImpl::limit ( )

overridevirtual

Returns the maximum number of peers we are configured to allow.

Implements ripple::Overlay.

Definition at line 851 of file OverlayImpl.cpp.

◆ size()

std::size_t ripple::OverlayImpl::size ( ) const

overridevirtual

The number of active peers on the network Active peers are only those peers that have completed the handshake and are running the Ripple protocol.

Implements ripple::Overlay.

Definition at line 844 of file OverlayImpl.cpp.

◆ json()

Json::Value ripple::OverlayImpl::json ( )

overridevirtual

Return diagnostics on the status of all peers.

Implements ripple::Overlay.

Definition at line 970 of file OverlayImpl.cpp.

◆ getActivePeers()

Overlay::PeerSequence ripple::OverlayImpl::getActivePeers ( ) const

overridevirtual

Returns a sequence representing the current list of peers.

The snapshot is made at the time of the call.

Implements ripple::Overlay.

Definition at line 1168 of file OverlayImpl.cpp.

◆ checkTracking()

void ripple::OverlayImpl::checkTracking ( std::uint32_t index )

overridevirtual

Calls the checkTracking function on each peer.

Parameters

index the value to pass to the peer's checkTracking function

Implements ripple::Overlay.

Definition at line 1181 of file OverlayImpl.cpp.

◆ findPeerByShortID()

std::shared_ptr< Peer > ripple::OverlayImpl::findPeerByShortID ( Peer::id_t const & id ) const

overridevirtual

Returns the peer with the matching short id, or null.

Implements ripple::Overlay.

Definition at line 1188 of file OverlayImpl.cpp.

◆ findPeerByPublicKey()

std::shared_ptr< Peer > ripple::OverlayImpl::findPeerByPublicKey ( PublicKey const & pubKey )

overridevirtual

Returns the peer with the matching public key, or null.

Implements ripple::Overlay.

Definition at line 1200 of file OverlayImpl.cpp.

◆ broadcast() [1/2]

void ripple::OverlayImpl::broadcast ( protocol::TMProposeSet & m )

overridevirtual

Broadcast a proposal.

Implements ripple::Overlay.

Definition at line 1215 of file OverlayImpl.cpp.

◆ broadcast() [2/2]

void ripple::OverlayImpl::broadcast ( protocol::TMValidation & m )

overridevirtual

Broadcast a validation.

Implements ripple::Overlay.

Definition at line 1241 of file OverlayImpl.cpp.

◆ relay() [1/2]

std::set< Peer::id_t > ripple::OverlayImpl::relay	(	protocol::TMProposeSet &	m,
		uint256 const &	uid,
		PublicKey const &	validator
	)

overridevirtual

Relay a proposal.

Parameters

m	the serialized proposal
uid	the id used to identify this proposal
validator	The pubkey of the validator that issued this proposal

Returns: the set of peers which have already sent us this proposal

Implements ripple::Overlay.

Definition at line 1222 of file OverlayImpl.cpp.

◆ relay() [2/2]

std::set< Peer::id_t > ripple::OverlayImpl::relay	(	protocol::TMValidation &	m,
		uint256 const &	uid,
		PublicKey const &	validator
	)

overridevirtual

Relay a validation.

Parameters

m	the serialized validation
uid	the id used to identify this validation
validator	The pubkey of the validator that issued this validation

Returns: the set of peers which have already sent us this validation

Implements ripple::Overlay.

Definition at line 1248 of file OverlayImpl.cpp.

◆ getManifestsMessage()

std::shared_ptr< Message > ripple::OverlayImpl::getManifestsMessage ( )

Definition at line 1267 of file OverlayImpl.cpp.

◆ add_active()

void ripple::OverlayImpl::add_active ( std::shared_ptr< PeerImp > const & peer )

Definition at line 440 of file OverlayImpl.cpp.

◆ remove() [1/3]

void ripple::OverlayImpl::remove ( std::shared_ptr< PeerFinder::Slot > const & slot )

Definition at line 474 of file OverlayImpl.cpp.

◆ activate()

void ripple::OverlayImpl::activate ( std::shared_ptr< PeerImp > const & peer )

Called when a peer has connected successfully This is called after the peer handshake has been completed and during peer activation.

A peer has connected successfully This is called after the peer handshake has been completed and during peer activation.

At this point, the peer address and the public key are known.

Definition at line 626 of file OverlayImpl.cpp.

◆ onPeerDeactivate()

void ripple::OverlayImpl::onPeerDeactivate ( Peer::id_t id )

Definition at line 650 of file OverlayImpl.cpp.

◆ for_each()

template<class UnaryFunc >

void ripple::OverlayImpl::for_each ( UnaryFunc && f ) const

Definition at line 260 of file OverlayImpl.h.

◆ onManifests()

void ripple::OverlayImpl::onManifests	(	std::shared_ptr< protocol::TMManifests > const &	m,
		std::shared_ptr< PeerImp > const &	from
	)

Definition at line 657 of file OverlayImpl.cpp.

◆ isPeerUpgrade() [1/2]

bool ripple::OverlayImpl::isPeerUpgrade ( http_request_type const & request )

static

Definition at line 338 of file OverlayImpl.cpp.

◆ isPeerUpgrade() [2/2]

template<class Body >

static bool ripple::OverlayImpl::isPeerUpgrade ( boost::beast::http::response< Body > const & response )

static

Definition at line 292 of file OverlayImpl.h.

◆ is_upgrade() [1/2]

template<class Fields >

static bool ripple::OverlayImpl::is_upgrade ( boost::beast::http::header< true, Fields > const & req )

static

Definition at line 302 of file OverlayImpl.h.

◆ is_upgrade() [2/2]

template<class Fields >

static bool ripple::OverlayImpl::is_upgrade ( boost::beast::http::header< false, Fields > const & req )

static

Definition at line 316 of file OverlayImpl.h.

◆ makePrefix()

std::string ripple::OverlayImpl::makePrefix ( std::uint32_t id )

static

Definition at line 347 of file OverlayImpl.cpp.

◆ reportTraffic()

void ripple::OverlayImpl::reportTraffic	(	TrafficCount::category	cat,
		bool	isInbound,
		int	bytes
	)

Definition at line 735 of file OverlayImpl.cpp.

◆ incJqTransOverflow()

void ripple::OverlayImpl::incJqTransOverflow ( )

overridevirtual

Increment and retrieve counter for transaction job queue overflows.

Implements ripple::Overlay.

Definition at line 333 of file OverlayImpl.h.

◆ getJqTransOverflow()

std::uint64_t ripple::OverlayImpl::getJqTransOverflow ( ) const

overridevirtual

Implements ripple::Overlay.

Definition at line 339 of file OverlayImpl.h.

◆ incPeerDisconnect()

void ripple::OverlayImpl::incPeerDisconnect ( )

overridevirtual

Increment and retrieve counters for total peer disconnects, and disconnects we initiate for excessive resource consumption.

Implements ripple::Overlay.

Definition at line 345 of file OverlayImpl.h.

◆ getPeerDisconnect()

std::uint64_t ripple::OverlayImpl::getPeerDisconnect ( ) const

overridevirtual

Implements ripple::Overlay.

Definition at line 351 of file OverlayImpl.h.

◆ incPeerDisconnectCharges()

void ripple::OverlayImpl::incPeerDisconnectCharges ( )

overridevirtual

Implements ripple::Overlay.

Definition at line 357 of file OverlayImpl.h.

◆ getPeerDisconnectCharges()

std::uint64_t ripple::OverlayImpl::getPeerDisconnectCharges ( ) const

overridevirtual

Implements ripple::Overlay.

Definition at line 363 of file OverlayImpl.h.

◆ networkID()

boost::optional<std::uint32_t> ripple::OverlayImpl::networkID ( ) const

overridevirtual

Returns the ID of the network this server is configured for, if any.

The ID is just a numerical identifier, with the IDs 0, 1 and 2 used to identify the mainnet, the testnet and the devnet respectively.

Returns: The numerical identifier configured by the administrator of the server. An unseated optional, otherwise.

Implements ripple::Overlay.

Definition at line 369 of file OverlayImpl.h.

◆ crawlShards()

Json::Value ripple::OverlayImpl::crawlShards	(	bool	pubKey,
		std::uint32_t	hops
	)

overridevirtual

Returns information reported to the crawl shard RPC command.

Parameters

hops	the maximum jumps the crawler will attempt. The number of hops achieved is not guaranteed.

Implements ripple::Overlay.

Definition at line 744 of file OverlayImpl.cpp.

◆ lastLink()

void ripple::OverlayImpl::lastLink ( std::uint32_t id )

Called when the last link from a peer chain is received.

Parameters

id	peer id that received the shard info.

Definition at line 829 of file OverlayImpl.cpp.

◆ updateSlotAndSquelch() [1/2]

void ripple::OverlayImpl::updateSlotAndSquelch	(	uint256 const &	key,
		PublicKey const &	validator,
		std::set< Peer::id_t > &&	peers,
		protocol::MessageType	type
	)

Updates message count for validator/peer.

Sends TMSquelch if the number of messages for N peers reaches threshold T. A message is counted if a peer receives the message for the first time and if the message has been relayed.

Parameters

key	Unique message's key
validator	Validator's public key
peers	Peers' id to update the slots for
type	Received protocol message type

Definition at line 1407 of file OverlayImpl.cpp.

◆ updateSlotAndSquelch() [2/2]

void ripple::OverlayImpl::updateSlotAndSquelch	(	uint256 const &	key,
		PublicKey const &	validator,
		Peer::id_t	peer,
		protocol::MessageType	type
	)

Overload to reduce allocation in case of single peer.

Definition at line 1425 of file OverlayImpl.cpp.

◆ deletePeer()

void ripple::OverlayImpl::deletePeer ( Peer::id_t id )

Called when the peer is deleted.

If the peer was selected to be the source of messages from the validator then squelched peers have to be unsquelched.

Parameters

id Peer's id

Definition at line 1440 of file OverlayImpl.cpp.

◆ squelch()

void ripple::OverlayImpl::squelch	(	PublicKey const &	validator,
		Peer::id_t const	id,
		std::uint32_t	duration
	)		const

overrideprivatevirtual

Squelch handler.

Parameters

validator	Public key of the source validator
id	Peer's id to squelch
duration	Squelch duration in seconds

Implements ripple::squelch::SquelchHandler.

Definition at line 1393 of file OverlayImpl.cpp.

◆ unsquelch()

void ripple::OverlayImpl::unsquelch	(	PublicKey const &	validator,
		Peer::id_t	id
	)		const

overrideprivatevirtual

Unsquelch handler.

Parameters

validator	Public key of the source validator
id	Peer's id to unsquelch

Implements ripple::squelch::SquelchHandler.

Definition at line 1380 of file OverlayImpl.cpp.

◆ makeRedirectResponse()

std::shared_ptr< Writer > ripple::OverlayImpl::makeRedirectResponse	(	std::shared_ptr< PeerFinder::Slot > const &	slot,
		http_request_type const &	request,
		address_type	remote_address
	)

private

Definition at line 355 of file OverlayImpl.cpp.

◆ makeErrorResponse()

std::shared_ptr< Writer > ripple::OverlayImpl::makeErrorResponse	(	std::shared_ptr< PeerFinder::Slot > const &	slot,
		http_request_type const &	request,
		address_type	remote_address,
		std::string	msg
	)

private

Definition at line 382 of file OverlayImpl.cpp.

◆ processCrawl()

bool ripple::OverlayImpl::processCrawl	(	http_request_type const &	req,
		Handoff &	handoff
	)

private

Handles crawl requests.

Crawl returns information about the node and its peers so crawlers can map the network.

Returns: true if the request was handled.

Definition at line 981 of file OverlayImpl.cpp.

◆ processValidatorList()

bool ripple::OverlayImpl::processValidatorList	(	http_request_type const &	req,
		Handoff &	handoff
	)

private

Handles validator list requests.

Using a /vl/<hex-encoded public key> URL, will retrieve the latest valdiator list (or UNL) that this node has for that public key, if the node trusts that public key.

Returns: true if the request was handled.

Definition at line 1018 of file OverlayImpl.cpp.

◆ processHealth()

bool ripple::OverlayImpl::processHealth	(	http_request_type const &	req,
		Handoff &	handoff
	)

private

Handles health requests.

Health returns information about the health of the node.

Returns: true if the request was handled.

Definition at line 1064 of file OverlayImpl.cpp.

◆ processRequest()

bool ripple::OverlayImpl::processRequest	(	http_request_type const &	req,
		Handoff &	handoff
	)

private

Handles non-peer protocol requests.

Returns: true if the request was handled.

Definition at line 1160 of file OverlayImpl.cpp.

◆ getOverlayInfo()

Json::Value ripple::OverlayImpl::getOverlayInfo ( )

private

Returns information about peers on the overlay network.

Reported through the /crawl API Controlled through the config section [crawl] overlay=[0|1]

Definition at line 857 of file OverlayImpl.cpp.

◆ getServerInfo()

Json::Value ripple::OverlayImpl::getServerInfo ( )

private

Returns information about the local server.

Reported through the /crawl API Controlled through the config section [crawl] server=[0|1]

Definition at line 905 of file OverlayImpl.cpp.

◆ getServerCounts()

Json::Value ripple::OverlayImpl::getServerCounts ( )

private

Returns information about the local server's performance counters.

Reported through the /crawl API Controlled through the config section [crawl] counts=[0|1]

Definition at line 933 of file OverlayImpl.cpp.

◆ getUnlInfo()

Json::Value ripple::OverlayImpl::getUnlInfo ( )

private

Returns information about the local server's UNL.

Reported through the /crawl API Controlled through the config section [crawl] unl=[0|1]

Definition at line 939 of file OverlayImpl.cpp.

◆ checkStopped()

void ripple::OverlayImpl::checkStopped ( )

private

Definition at line 490 of file OverlayImpl.cpp.

◆ onPrepare()

void ripple::OverlayImpl::onPrepare ( )

overrideprivatevirtual

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.

Reimplemented from ripple::Stoppable.

Definition at line 497 of file OverlayImpl.cpp.

◆ onStart()

void ripple::OverlayImpl::onStart ( )

overrideprivatevirtual

Override called during start.

Reimplemented from ripple::Stoppable.

Definition at line 572 of file OverlayImpl.cpp.

◆ onStop()

void ripple::OverlayImpl::onStop ( )

overrideprivatevirtual

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.

Reimplemented from ripple::Stoppable.

Definition at line 582 of file OverlayImpl.cpp.

◆ onChildrenStopped()

void ripple::OverlayImpl::onChildrenStopped ( )

overrideprivatevirtual

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.

Reimplemented from ripple::Stoppable.

Definition at line 588 of file OverlayImpl.cpp.

◆ onWrite()

void ripple::OverlayImpl::onWrite ( beast::PropertyStream::Map & )

overrideprivatevirtual

Subclass override.

The default version does nothing.

Reimplemented from beast::PropertyStream::Source.

Definition at line 601 of file OverlayImpl.cpp.

◆ remove() [2/3]

void ripple::OverlayImpl::remove ( Child & child )

private

Definition at line 1299 of file OverlayImpl.cpp.

◆ stop()

void ripple::OverlayImpl::stop ( )

private

Definition at line 1308 of file OverlayImpl.cpp.

◆ autoConnect()

void ripple::OverlayImpl::autoConnect ( )

private

Definition at line 1340 of file OverlayImpl.cpp.

◆ sendEndpoints()

void ripple::OverlayImpl::sendEndpoints ( )

private

Definition at line 1348 of file OverlayImpl.cpp.

◆ deleteIdlePeers()

void ripple::OverlayImpl::deleteIdlePeers ( )

private

Check if peers stopped relaying messages and if slots stopped receiving messages from the validator.

Definition at line 1449 of file OverlayImpl.cpp.

◆ collect_metrics()

void ripple::OverlayImpl::collect_metrics ( )

private

Definition at line 590 of file OverlayImpl.h.

◆ foreach()

template<class Function >

void ripple::Overlay::foreach ( Function f ) const

inherited

Visit every active peer.

The visitor must be invocable as: Function(std::shared_ptr<Peer> const& peer);

Parameters

f	the invocable to call with every peer

Definition at line 178 of file Overlay.h.

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

◆ 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() [3/3]

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.

Member Data Documentation

◆ app_

Application& ripple::OverlayImpl::app_

private

Definition at line 97 of file OverlayImpl.h.

◆ io_service_

boost::asio::io_service& ripple::OverlayImpl::io_service_

private

Definition at line 98 of file OverlayImpl.h.

◆ work_

boost::optional<boost::asio::io_service::work> ripple::OverlayImpl::work_

private

Definition at line 99 of file OverlayImpl.h.

◆ strand_

boost::asio::io_service::strand ripple::OverlayImpl::strand_

private

Definition at line 100 of file OverlayImpl.h.

◆ mutex_

std::recursive_mutex ripple::OverlayImpl::mutex_

mutableprivate

Definition at line 101 of file OverlayImpl.h.

◆ cond_

std::condition_variable_any ripple::OverlayImpl::cond_

private

Definition at line 102 of file OverlayImpl.h.

◆ timer_

std::weak_ptr<Timer> ripple::OverlayImpl::timer_

private

Definition at line 103 of file OverlayImpl.h.

◆ list_

boost::container::flat_map<Child*, std::weak_ptr<Child> > ripple::OverlayImpl::list_

private

Definition at line 104 of file OverlayImpl.h.

◆ setup_

Setup ripple::OverlayImpl::setup_

private

Definition at line 105 of file OverlayImpl.h.

◆ journal_

const beast::Journal ripple::OverlayImpl::journal_

private

Definition at line 106 of file OverlayImpl.h.

◆ serverHandler_

ServerHandler& ripple::OverlayImpl::serverHandler_

private

Definition at line 107 of file OverlayImpl.h.

◆ m_resourceManager

Resource::Manager& ripple::OverlayImpl::m_resourceManager

private

Definition at line 108 of file OverlayImpl.h.

◆ m_peerFinder

std::unique_ptr<PeerFinder::Manager> ripple::OverlayImpl::m_peerFinder

private

Definition at line 109 of file OverlayImpl.h.

◆ m_traffic

TrafficCount ripple::OverlayImpl::m_traffic

private

Definition at line 110 of file OverlayImpl.h.

◆ m_peers

hash_map<std::shared_ptr<PeerFinder::Slot>, std::weak_ptr<PeerImp> > ripple::OverlayImpl::m_peers

private

Definition at line 111 of file OverlayImpl.h.

◆ ids_

hash_map<Peer::id_t, std::weak_ptr<PeerImp> > ripple::OverlayImpl::ids_

private

Definition at line 112 of file OverlayImpl.h.

◆ m_resolver

Resolver& ripple::OverlayImpl::m_resolver

private

Definition at line 113 of file OverlayImpl.h.

◆ next_id_

std::atomic<Peer::id_t> ripple::OverlayImpl::next_id_

private

Definition at line 114 of file OverlayImpl.h.

◆ timer_count_

int ripple::OverlayImpl::timer_count_

private

Definition at line 115 of file OverlayImpl.h.

◆ jqTransOverflow_

std::atomic<uint64_t> ripple::OverlayImpl::jqTransOverflow_ {0}

private

Definition at line 116 of file OverlayImpl.h.

◆ peerDisconnects_

std::atomic<uint64_t> ripple::OverlayImpl::peerDisconnects_ {0}

private

Definition at line 117 of file OverlayImpl.h.

◆ peerDisconnectsCharges_

std::atomic<uint64_t> ripple::OverlayImpl::peerDisconnectsCharges_ {0}

private

Definition at line 118 of file OverlayImpl.h.

◆ csLast_

std::atomic<std::chrono::seconds> ripple::OverlayImpl::csLast_ {std::chrono::seconds{0}}

private

Definition at line 121 of file OverlayImpl.h.

◆ csMutex_

std::mutex ripple::OverlayImpl::csMutex_

private

Definition at line 122 of file OverlayImpl.h.

◆ csCV_

std::condition_variable ripple::OverlayImpl::csCV_

private

Definition at line 123 of file OverlayImpl.h.

◆ csIDs_

std::set<std::uint32_t> ripple::OverlayImpl::csIDs_

private

Definition at line 125 of file OverlayImpl.h.

◆ networkID_

boost::optional<std::uint32_t> ripple::OverlayImpl::networkID_

private

Definition at line 127 of file OverlayImpl.h.

◆ slots_

squelch::Slots<UptimeClock> ripple::OverlayImpl::slots_

private

Definition at line 129 of file OverlayImpl.h.

◆ manifestMessage_

std::shared_ptr<Message> ripple::OverlayImpl::manifestMessage_

private

Definition at line 132 of file OverlayImpl.h.

◆ manifestListSeq_

std::optional<std::uint32_t> ripple::OverlayImpl::manifestListSeq_

private

Definition at line 134 of file OverlayImpl.h.

◆ manifestLock_

std::mutex ripple::OverlayImpl::manifestLock_

private

Definition at line 136 of file OverlayImpl.h.

◆ m_stats

Stats ripple::OverlayImpl::m_stats

private

Definition at line 585 of file OverlayImpl.h.

◆ m_statsMutex

std::mutex ripple::OverlayImpl::m_statsMutex

private

Definition at line 586 of file OverlayImpl.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ clock_type

◆ socket_type

◆ address_type

◆ endpoint_type

◆ error_code

◆ stream_type

◆ PeerSequence

◆ Children

Member Enumeration Documentation

◆ Promote

Constructor & Destructor Documentation

◆ OverlayImpl() [1/2]

◆ ~OverlayImpl()

◆ OverlayImpl() [2/2]

Member Function Documentation

◆ operator=()

◆ peerFinder()

◆ resourceManager()

◆ serverHandler()

◆ setup()

◆ onHandoff()

◆ connect()

◆ limit()

◆ size()

◆ json()

◆ getActivePeers()

◆ checkTracking()

◆ findPeerByShortID()

◆ findPeerByPublicKey()

◆ broadcast() [1/2]

◆ broadcast() [2/2]

◆ relay() [1/2]

◆ relay() [2/2]

◆ getManifestsMessage()

◆ add_active()

◆ remove() [1/3]

◆ activate()

◆ onPeerDeactivate()

◆ for_each()

◆ onManifests()

◆ isPeerUpgrade() [1/2]

◆ isPeerUpgrade() [2/2]

◆ is_upgrade() [1/2]

◆ is_upgrade() [2/2]

◆ makePrefix()

◆ reportTraffic()

◆ incJqTransOverflow()

◆ getJqTransOverflow()

◆ incPeerDisconnect()

◆ getPeerDisconnect()

◆ incPeerDisconnectCharges()

◆ getPeerDisconnectCharges()

◆ networkID()

◆ crawlShards()

◆ lastLink()

◆ updateSlotAndSquelch() [1/2]

◆ updateSlotAndSquelch() [2/2]

◆ deletePeer()

◆ squelch()

◆ unsquelch()

◆ makeRedirectResponse()

◆ makeErrorResponse()

◆ processCrawl()

◆ processValidatorList()

◆ processHealth()

◆ processRequest()

◆ getOverlayInfo()

◆ getServerInfo()

◆ getServerCounts()