A NodeStore::Scheduler which uses the JobQueue and implements the Stoppable API. More...

Inheritance diagram for ripple::NodeStoreScheduler:

Collaboration diagram for ripple::NodeStoreScheduler:

[legend]

Public Member Functions
	NodeStoreScheduler (Stoppable &parent)

void	setJobQueue (JobQueue &jobQueue)

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

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

void	scheduleTask (NodeStore::Task &task) override
	Schedules a task. More...

void	onFetch (NodeStore::FetchReport const &report) override
	Reports completion of a fetch Allows the scheduler to monitor the node store's performance. More...

void	onBatchWrite (NodeStore::BatchWriteReport const &report) override
	Reports the completion of a batch write Allows the scheduler to monitor the node store's performance. 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
void	doTask (NodeStore::Task &task)

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

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

void	prepareRecursive ()

void	startRecursive ()

void	stopAsyncRecursive (beast::Journal j)

void	stopRecursive (beast::Journal j)

Private Attributes
JobQueue *	m_jobQueue {nullptr}

std::atomic< int >	m_taskCount {0}

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

A NodeStore::Scheduler which uses the JobQueue and implements the Stoppable API.

Definition at line 32 of file NodeStoreScheduler.h.

Member Typedef Documentation

◆ Children

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

privateinherited

Definition at line 318 of file Stoppable.h.

Constructor & Destructor Documentation

◆ NodeStoreScheduler()

ripple::NodeStoreScheduler::NodeStoreScheduler ( Stoppable & parent )

Definition at line 25 of file NodeStoreScheduler.cpp.

Member Function Documentation

◆ setJobQueue()

void ripple::NodeStoreScheduler::setJobQueue ( JobQueue & jobQueue )

Definition at line 31 of file NodeStoreScheduler.cpp.

◆ onStop()

void ripple::NodeStoreScheduler::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 37 of file NodeStoreScheduler.cpp.

◆ onChildrenStopped()

void ripple::NodeStoreScheduler::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 42 of file NodeStoreScheduler.cpp.

◆ scheduleTask()

void ripple::NodeStoreScheduler::scheduleTask ( NodeStore::Task & task )

overridevirtual

Schedules a task.

Depending on the implementation, the task may be invoked either on the current thread of execution, or an unspecified implementation-defined foreign thread.

Implements ripple::NodeStore::Scheduler.

Definition at line 49 of file NodeStoreScheduler.cpp.

◆ onFetch()

void ripple::NodeStoreScheduler::onFetch ( NodeStore::FetchReport const & report )

overridevirtual

Reports completion of a fetch Allows the scheduler to monitor the node store's performance.

Implements ripple::NodeStore::Scheduler.

Definition at line 79 of file NodeStoreScheduler.cpp.

◆ onBatchWrite()

void ripple::NodeStoreScheduler::onBatchWrite ( NodeStore::BatchWriteReport const & report )

overridevirtual

Reports the completion of a batch write Allows the scheduler to monitor the node store's performance.

Implements ripple::NodeStore::Scheduler.

Definition at line 89 of file NodeStoreScheduler.cpp.

◆ doTask()

void ripple::NodeStoreScheduler::doTask ( NodeStore::Task & task )

private

Definition at line 63 of file NodeStoreScheduler.cpp.

◆ getRoot()

RootStoppable& ripple::Stoppable::getRoot ( )

inherited

Definition at line 213 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 436 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 454 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

◆ 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

◆ m_jobQueue

JobQueue* ripple::NodeStoreScheduler::m_jobQueue {nullptr}

private

Definition at line 58 of file NodeStoreScheduler.h.

◆ m_taskCount

std::atomic<int> ripple::NodeStoreScheduler::m_taskCount {0}

private

Definition at line 59 of file NodeStoreScheduler.h.

◆ m_name

std::string ripple::Stoppable::m_name

privateinherited

Definition at line 338 of file Stoppable.h.

◆ m_root

RootStoppable& ripple::Stoppable::m_root

privateinherited

Definition at line 339 of file Stoppable.h.

◆ m_child

Child ripple::Stoppable::m_child

privateinherited

Definition at line 340 of file Stoppable.h.

◆ m_stopped

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

privateinherited

Definition at line 341 of file Stoppable.h.

◆ m_childrenStopped

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

privateinherited

Definition at line 342 of file Stoppable.h.

◆ m_children

Children ripple::Stoppable::m_children

privateinherited

Definition at line 343 of file Stoppable.h.

◆ m_cv

std::condition_variable ripple::Stoppable::m_cv

privateinherited

Definition at line 344 of file Stoppable.h.

◆ m_mut

std::mutex ripple::Stoppable::m_mut

privateinherited

Definition at line 345 of file Stoppable.h.

◆ m_is_stopping

bool ripple::Stoppable::m_is_stopping = false

privateinherited

Definition at line 346 of file Stoppable.h.

◆ hasParent_

bool ripple::Stoppable::hasParent_ {false}

privateinherited

Definition at line 347 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

◆ NodeStoreScheduler()

Member Function Documentation

◆ setJobQueue()

◆ onStop()

◆ onChildrenStopped()

◆ scheduleTask()

◆ onFetch()

◆ onBatchWrite()

◆ doTask()

◆ getRoot()

◆ setParent()

◆ isStopping()

◆ isStopped()

◆ areChildrenStopped()

◆ jobCounter()

◆ alertable_sleep_until()

◆ stopped()

◆ onPrepare()

◆ onStart()

◆ prepareRecursive()

◆ startRecursive()

◆ stopAsyncRecursive()

◆ stopRecursive()

Member Data Documentation

◆ m_jobQueue

◆ m_taskCount

◆ m_name

◆ m_root

◆ m_child

◆ m_stopped

◆ m_childrenStopped

◆ m_children

◆ m_cv

◆ m_mut

◆ m_is_stopping

◆ hasParent_