Inheritance diagram for ripple::test::Stoppable_test::Root:

Collaboration diagram for ripple::test::Stoppable_test::Root:

[legend]

Public Member Functions
	Root (Stoppable_test &test)

void	run ()

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

bool	isStopping () const

void	prepare ()
	Prepare all contained Stoppable objects. More...

void	start ()
	Start all contained Stoppable objects. More...

void	stop (beast::Journal j)
	Notify a root stoppable and children to stop, and block until stopped. More...

bool	started () const
	Return true if start() was ever called. More...

JobCounter &	jobCounter ()

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

RootStoppable &	getRoot ()

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

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

bool	areChildrenStopped () const
	Returns `true` if all children have stopped. 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
bool	stopAsync (beast::Journal j)

void	prepareRecursive ()

void	startRecursive ()

void	stopAsyncRecursive (beast::Journal j)

void	stopRecursive (beast::Journal j)

Private Attributes
std::thread	a_

B	b_

C	c_

Stoppable_test &	test_

SuiteJournal	journal_

std::atomic< bool >	m_prepared {false}

std::atomic< bool >	m_started {false}

std::atomic< bool >	m_calledStop {false}

std::mutex	m_

JobCounter	jobCounter_

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}

Detailed Description

Definition at line 457 of file Stoppable_test.cpp.

Member Typedef Documentation

◆ Children

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

privateinherited

Definition at line 319 of file Stoppable.h.

Constructor & Destructor Documentation

◆ Root()

ripple::test::Stoppable_test::Root::Root ( Stoppable_test & test )

explicit

Definition at line 466 of file Stoppable_test.cpp.

Member Function Documentation

◆ run()

void ripple::test::Stoppable_test::Root::run ( )

Definition at line 477 of file Stoppable_test.cpp.

◆ onPrepare()

void ripple::test::Stoppable_test::Root::onPrepare ( )

overridevirtual

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 485 of file Stoppable_test.cpp.

◆ onStart()

void ripple::test::Stoppable_test::Root::onStart ( )

overridevirtual

Override called during start.

Reimplemented from ripple::Stoppable.

Definition at line 492 of file Stoppable_test.cpp.

◆ onStop()

void ripple::test::Stoppable_test::Root::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 499 of file Stoppable_test.cpp.

◆ onChildrenStopped()

void ripple::test::Stoppable_test::Root::onChildrenStopped ( )

overridevirtual

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 506 of file Stoppable_test.cpp.

◆ secondStop()

void ripple::test::Stoppable_test::Root::secondStop ( )

Definition at line 516 of file Stoppable_test.cpp.

◆ isStopping()

bool ripple::RootStoppable::isStopping ( ) const

inherited

Definition at line 175 of file Stoppable.cpp.

◆ prepare()

void ripple::RootStoppable::prepare ( )

inherited

Prepare all contained Stoppable objects.

This calls onPrepare for all Stoppable objects in the tree. Calls made after the first have no effect. Thread safety: May be called from any thread.

Definition at line 181 of file Stoppable.cpp.

◆ start()

void ripple::RootStoppable::start ( )

inherited

Start all contained Stoppable objects.

The default implementation does nothing. Calls made after the first have no effect. Thread safety: May be called from any thread.

Definition at line 188 of file Stoppable.cpp.

◆ stop()

void ripple::RootStoppable::stop ( beast::Journal j )

inherited

Notify a root stoppable and children to stop, and block until stopped.

Has no effect if the stoppable was already notified. This blocks until the stoppable and all of its children have stopped. Undefined behavior results if stop() is called without a previous call to start(). Thread safety: Safe to call from any thread not associated with a Stoppable.

Definition at line 199 of file Stoppable.cpp.

◆ started()

bool ripple::RootStoppable::started ( ) const

inherited

Return true if start() was ever called.

Definition at line 394 of file Stoppable.h.

◆ jobCounter()

JobCounter& ripple::RootStoppable::jobCounter ( )

inherited

Definition at line 401 of file Stoppable.h.

◆ alertable_sleep_until()

bool ripple::RootStoppable::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 445 of file Stoppable.h.

◆ stopAsync()

bool ripple::RootStoppable::stopAsync ( beast::Journal j )

privateinherited

Definition at line 209 of file Stoppable.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.

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

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

Member Data Documentation

◆ a_

std::thread ripple::test::Stoppable_test::Root::a_

private

Definition at line 459 of file Stoppable_test.cpp.

◆ b_

B ripple::test::Stoppable_test::Root::b_

private

Definition at line 460 of file Stoppable_test.cpp.

◆ c_

C ripple::test::Stoppable_test::Root::c_

private

Definition at line 461 of file Stoppable_test.cpp.

◆ test_

Stoppable_test& ripple::test::Stoppable_test::Root::test_

private

Definition at line 462 of file Stoppable_test.cpp.

◆ journal_

SuiteJournal ripple::test::Stoppable_test::Root::journal_

private

Definition at line 463 of file Stoppable_test.cpp.

◆ m_prepared

std::atomic<bool> ripple::RootStoppable::m_prepared {false}

privateinherited

Definition at line 425 of file Stoppable.h.

◆ m_started

std::atomic<bool> ripple::RootStoppable::m_started {false}

privateinherited

Definition at line 426 of file Stoppable.h.

◆ m_calledStop

std::atomic<bool> ripple::RootStoppable::m_calledStop {false}

privateinherited

Definition at line 427 of file Stoppable.h.

◆ m_

std::mutex ripple::RootStoppable::m_

privateinherited

Definition at line 428 of file Stoppable.h.

◆ jobCounter_

JobCounter ripple::RootStoppable::jobCounter_

privateinherited

Definition at line 430 of file Stoppable.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.

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Children

Constructor & Destructor Documentation

◆ Root()

Member Function Documentation

◆ run()

◆ onPrepare()

◆ onStart()

◆ onStop()

◆ onChildrenStopped()

◆ secondStop()

◆ isStopping()

◆ prepare()

◆ start()

◆ stop()

◆ started()

◆ jobCounter()

◆ alertable_sleep_until()

◆ stopAsync()

◆ getRoot()

◆ setParent()

◆ isStopped()

◆ areChildrenStopped()

◆ stopped()

◆ prepareRecursive()

◆ startRecursive()

◆ stopAsyncRecursive()

◆ stopRecursive()

Member Data Documentation

◆ a_

◆ b_

◆ c_

◆ test_

◆ journal_

◆ m_prepared

◆ m_started

◆ m_calledStop

◆ m_

◆ jobCounter_

◆ m_name

◆ m_root

◆ m_child

◆ m_stopped

◆ m_childrenStopped

◆ m_children

◆ m_cv

◆ m_mut

◆ m_is_stopping

◆ hasParent_