Manages load sources. More...

Inheritance diagram for ripple::LoadManager:

Collaboration diagram for ripple::LoadManager:

[legend]

Public Member Functions
	LoadManager ()=delete

	LoadManager (LoadManager const &)=delete

LoadManager &	operator= (LoadManager const &)=delete

	~LoadManager ()
	Destroy the manager. More...

void	activateDeadlockDetector ()
	Turn on deadlock detection. More...

void	resetDeadlockDetector ()
	Reset the deadlock detection timer. More...

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

void	onStop () override
	Override called when the stop notification is issued. 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...

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

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

Private Member Functions
	LoadManager (Application &app, Stoppable &parent, beast::Journal journal)

void	run ()

virtual void	onPrepare ()
	Override called during preparation. 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
Application &	app_

const beast::Journal	journal_

std::thread	thread_

std::mutex	mutex_

std::chrono::steady_clock::time_point	deadLock_

bool	armed_

bool	stop_

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}

Friends
std::unique_ptr< LoadManager >	make_LoadManager (Application &app, Stoppable &parent, beast::Journal journal)

Detailed Description

Manages load sources.

This object creates an associated thread to maintain a clock.

When the server is overloaded by a particular peer it issues a warning first. This allows friendly peers to reduce their consumption of resources, or disconnect from the server.

The warning system is used instead of merely dropping, because hostile peers can just reconnect anyway.

Definition at line 43 of file LoadManager.h.

Member Typedef Documentation

◆ Children

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

privateinherited

Definition at line 319 of file Stoppable.h.

Constructor & Destructor Documentation

◆ LoadManager() [1/3]

ripple::LoadManager::LoadManager	(	Application &	app,
		Stoppable &	parent,
		beast::Journal	journal
	)

private

Definition at line 33 of file LoadManager.cpp.

◆ LoadManager() [2/3]

ripple::LoadManager::LoadManager ( )

delete

◆ LoadManager() [3/3]

ripple::LoadManager::LoadManager ( LoadManager const & )

delete

◆ ~LoadManager()

ripple::LoadManager::~LoadManager ( )

Destroy the manager.

The destructor returns only after the thread has stopped.

Definition at line 46 of file LoadManager.cpp.

Member Function Documentation

◆ operator=()

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

delete

◆ activateDeadlockDetector()

void ripple::LoadManager::activateDeadlockDetector ( )

Turn on deadlock detection.

The deadlock detector begins in a disabled state. After this function is called, it will report deadlocks using a separate thread whenever the reset function is not called at least once per 10 seconds.

See also: resetDeadlockDetector

Definition at line 63 of file LoadManager.cpp.

◆ resetDeadlockDetector()

void ripple::LoadManager::resetDeadlockDetector ( )

Reset the deadlock detection timer.

A dedicated thread monitors the deadlock timer, and if too much time passes it will produce log warnings.

Definition at line 71 of file LoadManager.cpp.

◆ onStart()

void ripple::LoadManager::onStart ( )

overridevirtual

Override called during start.

Reimplemented from ripple::Stoppable.

Definition at line 81 of file LoadManager.cpp.

◆ onStop()

void ripple::LoadManager::onStop ( )

overridevirtual

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 90 of file LoadManager.cpp.

◆ run()

void ripple::LoadManager::run ( )

private

Definition at line 107 of file LoadManager.cpp.

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

Reimplemented in ripple::OverlayImpl, ripple::test::Stoppable_test::Root, ripple::test::Stoppable_test::C, ripple::test::Stoppable_test::I, ripple::test::Stoppable_test::B, ripple::test::Stoppable_test::H, ripple::test::Stoppable_test::G, ripple::test::Stoppable_test::A, ripple::PeerFinder::ManagerImp, ripple::test::Stoppable_test::F, ripple::test::Stoppable_test::E, ripple::test::Stoppable_test::J, ripple::PerfLog_test::PerfLogParent, and ripple::test::Stoppable_test::D.

Definition at line 80 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.

Friends And Related Function Documentation

◆ make_LoadManager

std::unique_ptr<LoadManager> make_LoadManager	(	Application &	app,
		Stoppable &	parent,
		beast::Journal	journal
	)

friend

Definition at line 216 of file LoadManager.cpp.

Member Data Documentation

◆ app_

Application& ripple::LoadManager::app_

private

Definition at line 96 of file LoadManager.h.

◆ journal_

const beast::Journal ripple::LoadManager::journal_

private

Definition at line 97 of file LoadManager.h.

◆ thread_

std::thread ripple::LoadManager::thread_

private

Definition at line 99 of file LoadManager.h.

◆ mutex_

std::mutex ripple::LoadManager::mutex_

private

Definition at line 100 of file LoadManager.h.

◆ deadLock_

std::chrono::steady_clock::time_point ripple::LoadManager::deadLock_

private

Definition at line 103 of file LoadManager.h.

◆ armed_

bool ripple::LoadManager::armed_

private

Definition at line 104 of file LoadManager.h.

◆ stop_

bool ripple::LoadManager::stop_

private

Definition at line 105 of file LoadManager.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 343 of file Stoppable.h.

◆ m_childrenStopped

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

privateinherited

Definition at line 344 of file Stoppable.h.

◆ m_children

Children ripple::Stoppable::m_children

privateinherited

Definition at line 345 of file Stoppable.h.

◆ m_cv

std::condition_variable ripple::Stoppable::m_cv

privateinherited

Definition at line 346 of file Stoppable.h.

◆ m_mut

std::mutex ripple::Stoppable::m_mut

privateinherited

Definition at line 347 of file Stoppable.h.

◆ m_is_stopping

bool ripple::Stoppable::m_is_stopping = false

privateinherited

Definition at line 348 of file Stoppable.h.

◆ hasParent_

bool ripple::Stoppable::hasParent_ {false}

privateinherited

Definition at line 349 of file Stoppable.h.

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Children

Constructor & Destructor Documentation

◆ LoadManager() [1/3]

◆ LoadManager() [2/3]

◆ LoadManager() [3/3]

◆ ~LoadManager()

Member Function Documentation

◆ operator=()

◆ activateDeadlockDetector()

◆ resetDeadlockDetector()

◆ onStart()

◆ onStop()

◆ run()

◆ getRoot()

◆ setParent()

◆ isStopping()

◆ isStopped()

◆ areChildrenStopped()

◆ jobCounter()

◆ alertable_sleep_until()

◆ stopped()

◆ onPrepare()

◆ onChildrenStopped()

◆ prepareRecursive()

◆ startRecursive()

◆ stopAsyncRecursive()

◆ stopRecursive()

Friends And Related Function Documentation

◆ make_LoadManager

Member Data Documentation

◆ app_

◆ journal_

◆ thread_

◆ mutex_

◆ deadLock_

◆ armed_

◆ stop_

◆ m_name

◆ m_root

◆ m_child

◆ m_stopped

◆ m_childrenStopped

◆ m_children

◆ m_cv

◆ m_mut

◆ m_is_stopping

◆ hasParent_