WorkQueue< WorkItem > Class Template Reference

Simple work queue for distributing work over multiple threads. More...

Classes
class	ThreadCounter
	RAII object to keep track of number of running worker threads. More...

Public Member Functions
	WorkQueue (size_t _maxDepth)
	~WorkQueue ()
	Precondition: worker threads have all stopped (call WaitExit) More...
bool	Enqueue (WorkItem *item)
	Enqueue a work item. More...
void	Run ()
	Thread function. More...
void	Interrupt ()
	Interrupt and exit loops. More...
void	WaitExit ()
	Wait for worker threads to exit. More...

Private Attributes
std::mutex	cs
	Mutex protects entire object. More...
std::condition_variable	cond
std::deque< std::unique_ptr< WorkItem > >	queue
bool	running
size_t	maxDepth
int	numThreads

Detailed Description

template<typename WorkItem>
class WorkQueue< WorkItem >

Simple work queue for distributing work over multiple threads.

Work items are simply callable objects.

Definition at line 67 of file httpserver.cpp.

Constructor & Destructor Documentation

WorkQueue()

template<typename WorkItem>

WorkQueue< WorkItem >::WorkQueue ( size_t  _maxDepth )

inlineexplicit

Definition at line 97 of file httpserver.cpp.

~WorkQueue()

template<typename WorkItem>

WorkQueue< WorkItem >::~WorkQueue ( )

inline

Precondition: worker threads have all stopped (call WaitExit)

Definition at line 105 of file httpserver.cpp.

Member Function Documentation

Enqueue()

template<typename WorkItem>

bool WorkQueue< WorkItem >::Enqueue ( WorkItem *  item )

inline

Enqueue a work item.

Definition at line 109 of file httpserver.cpp.

Interrupt()

template<typename WorkItem>

void WorkQueue< WorkItem >::Interrupt ( )

inline

Interrupt and exit loops.

Definition at line 138 of file httpserver.cpp.

Run()

template<typename WorkItem>

void WorkQueue< WorkItem >::Run ( )

inline

Thread function.

Definition at line 120 of file httpserver.cpp.

WaitExit()

template<typename WorkItem>

void WorkQueue< WorkItem >::WaitExit ( )

inline

Wait for worker threads to exit.

Definition at line 145 of file httpserver.cpp.

Here is the caller graph for this function:

Member Data Documentation

cond

template<typename WorkItem>

std::condition_variable WorkQueue< WorkItem >::cond

private

Definition at line 72 of file httpserver.cpp.

cs

template<typename WorkItem>

std::mutex WorkQueue< WorkItem >::cs

private

Mutex protects entire object.

Definition at line 71 of file httpserver.cpp.

maxDepth

template<typename WorkItem>

size_t WorkQueue< WorkItem >::maxDepth

private

Definition at line 75 of file httpserver.cpp.

numThreads

template<typename WorkItem>

int WorkQueue< WorkItem >::numThreads

private

Definition at line 76 of file httpserver.cpp.

queue

template<typename WorkItem>

std::deque<std::unique_ptr<WorkItem> > WorkQueue< WorkItem >::queue

private

Definition at line 73 of file httpserver.cpp.

running

template<typename WorkItem>

bool WorkQueue< WorkItem >::running

private

Definition at line 74 of file httpserver.cpp.

---

The documentation for this class was generated from the following file:

• src/httpserver.cpp