ripple::Workers Class Reference

A group of threads that process tasks. More...

Collaboration diagram for ripple::Workers:

Classes
struct	Callback
	Called to perform tasks as needed. More...
struct	PausedTag
class	Worker

Public Member Functions
	Workers (Callback &callback, perf::PerfLog *perfLog, std::string const &threadNames="Worker", int numberOfThreads=static_cast< int >(std::thread::hardware_concurrency()))
	Create the object. More...
	~Workers ()
int	getNumberOfThreads () const noexcept
	Retrieve the desired number of threads. More...
void	setNumberOfThreads (int numberOfThreads)
	Set the desired number of threads. More...
void	pauseAllThreadsAndWait ()
	Pause all threads and wait until they are paused. More...
void	addTask ()
	Add a task to be performed. More...
int	numberOfCurrentlyRunningTasks () const noexcept
	Get the number of currently executing calls of Callback::processTask. More...

Static Private Member Functions
static void	deleteWorkers (beast::LockFreeStack< Worker > &stack)

Private Attributes
Callback &	m_callback
perf::PerfLog *	perfLog_
std::string	m_threadNames
std::condition_variable	m_cv
std::mutex	m_mut
bool	m_allPaused
semaphore	m_semaphore
int	m_numberOfThreads
std::atomic< int >	m_activeCount
std::atomic< int >	m_pauseCount
std::atomic< int >	m_runningTaskCount
beast::LockFreeStack< Worker >	m_everyone
beast::LockFreeStack< Worker, PausedTag >	m_paused

Detailed Description

A group of threads that process tasks.

Definition at line 39 of file Workers.h.

Constructor & Destructor Documentation

Workers()

ripple::Workers::Workers ( Callback &  callback, perf::PerfLog *  perfLog, std::string const &  threadNames = "Worker", int  numberOfThreads = static_cast<int>(std::thread::hardware_concurrency())  )

explicit

Create the object.

A number of initial threads may be optionally specified. The default is to create one thread per CPU.

Parameters

threadNames

The name given to each created worker thread.

Definition at line 27 of file Workers.cpp.

~Workers()

ripple::Workers::~Workers

(

)

Definition at line 45 of file Workers.cpp.

Member Function Documentation

getNumberOfThreads()

int ripple::Workers::getNumberOfThreads ( ) const

noexcept

Retrieve the desired number of threads.

This just returns the number of active threads that were requested. If there was a recent call to setNumberOfThreads, the actual number of active threads may be temporarily different from what was last requested.

Note

This function is not thread-safe.

Definition at line 53 of file Workers.cpp.

setNumberOfThreads()

void ripple::Workers::setNumberOfThreads

(

int

numberOfThreads

)

Set the desired number of threads.

Note

This function is not thread-safe.

Definition at line 63 of file Workers.cpp.

pauseAllThreadsAndWait()

void ripple::Workers::pauseAllThreadsAndWait

(

)

Pause all threads and wait until they are paused.

If a thread is processing a task it will pause as soon as the task completes. There may still be tasks signaled even after all threads have paused.

Note

This function is not thread-safe.

Definition at line 114 of file Workers.cpp.

addTask()

void ripple::Workers::addTask

(

)

Add a task to be performed.

Every call to addTask will eventually result in a call to Callback::processTask unless the Workers object is destroyed or the number of threads is never set above zero.

Note

This function is thread-safe.

Definition at line 126 of file Workers.cpp.

numberOfCurrentlyRunningTasks()

int ripple::Workers::numberOfCurrentlyRunningTasks ( ) const

noexcept

Get the number of currently executing calls of Callback::processTask.

While this function is thread-safe, the value may not stay accurate for very long. It's mainly for diagnostic purposes.

Definition at line 132 of file Workers.cpp.

deleteWorkers()

void ripple::Workers::deleteWorkers ( beast::LockFreeStack< Worker > &  stack )

staticprivate

Definition at line 138 of file Workers.cpp.

Member Data Documentation

m_callback

Callback& ripple::Workers::m_callback

private

Definition at line 178 of file Workers.h.

perfLog_

perf::PerfLog* ripple::Workers::perfLog_

private

Definition at line 179 of file Workers.h.

m_threadNames

std::string ripple::Workers::m_threadNames

private

Definition at line 180 of file Workers.h.

m_cv

std::condition_variable ripple::Workers::m_cv

private

Definition at line 181 of file Workers.h.

m_mut

std::mutex ripple::Workers::m_mut

private

Definition at line 182 of file Workers.h.

m_allPaused

bool ripple::Workers::m_allPaused

private

Definition at line 183 of file Workers.h.

m_semaphore

semaphore ripple::Workers::m_semaphore

private

Definition at line 184 of file Workers.h.

m_numberOfThreads

int ripple::Workers::m_numberOfThreads

private

Definition at line 185 of file Workers.h.

m_activeCount

std::atomic<int> ripple::Workers::m_activeCount

private

Definition at line 186 of file Workers.h.

m_pauseCount

std::atomic<int> ripple::Workers::m_pauseCount

private

Definition at line 187 of file Workers.h.

m_runningTaskCount

std::atomic<int> ripple::Workers::m_runningTaskCount

private

Definition at line 189 of file Workers.h.

m_everyone

beast::LockFreeStack<Worker> ripple::Workers::m_everyone

private

Definition at line 190 of file Workers.h.

m_paused

beast::LockFreeStack<Worker, PausedTag> ripple::Workers::m_paused

private

Definition at line 192 of file Workers.h.