Scroom::Detail::ThreadPool::QueueImpl Class Reference

#include <queue.hh>

Collaboration diagram for Scroom::Detail::ThreadPool::QueueImpl:

Public Types
using	Ptr = std::shared_ptr< QueueImpl >

Public Member Functions
bool	jobStarted ()
void	jobFinished ()
void	deletingQueue ()
int	getCount ()

Static Public Member Functions
static Ptr	create ()
	QueueImpl.

Private Member Functions
	QueueImpl ()=default

Private Attributes
boost::mutex	mut
boost::condition_variable	cond
unsigned int	count {0}
bool	isDeleted {false}

Detailed Description

ThreadPool::Queue implementation class.

Keeps track of whether the actual ThreadPool::Queue still exists, and whether jobs are currently being executed. When the last reference to the ThreadPool::Queue is being deleted, it calls deletingQueue(), which blocks until all jobs finish executing.

Member Typedef Documentation

Ptr

using Scroom::Detail::ThreadPool::QueueImpl::Ptr = std::shared_ptr<QueueImpl>

Constructor & Destructor Documentation

QueueImpl()

Scroom::Detail::ThreadPool::QueueImpl::QueueImpl ( )

privatedefault

Referenced by create().

Here is the caller graph for this function:

Member Function Documentation

create()

QueueImpl::Ptr QueueImpl::create ( )

static

QueueImpl.

{ return QueueImpl::Ptr(new QueueImpl()); }

Here is the call graph for this function:

deletingQueue()

void QueueImpl::deletingQueue

(

)

Indicate that the ThreadPool::Queue is being deleted

This sets isDeleted to true and blocks until all jobs have finished executing.

{
  boost::mutex::scoped_lock lock(mut);
  isDeleted = true;
  while(count != 0)
  {
    cond.wait(lock);
  }
}

getCount()

int QueueImpl::getCount

(

)

Return the number of jobs currently running. Used for testing

{
  boost::mutex::scoped_lock const lock(mut);
  return count;
}

jobFinished()

void QueueImpl::jobFinished

(

)

Indicate that a job is finished

{
  boost::mutex::scoped_lock const lock(mut);
  count--;
  cond.notify_all();
}

jobStarted()

bool QueueImpl::jobStarted

(

)

Indicate that a job is being started

Return values

true	if the ThreadPool::Queue still exists
false	if the ThreadPool::Queue has been deleted

{
  boost::mutex::scoped_lock const lock(mut);
  count++;
 
  return !isDeleted;
}

Member Data Documentation

cond

boost::condition_variable Scroom::Detail::ThreadPool::QueueImpl::cond

private

Gets signaled when a job completes

Referenced by deletingQueue(), and jobFinished().

count

unsigned int Scroom::Detail::ThreadPool::QueueImpl::count {0}

private

Number of jobs currently running

{0}; 

Referenced by deletingQueue(), getCount(), jobFinished(), and jobStarted().

isDeleted

bool Scroom::Detail::ThreadPool::QueueImpl::isDeleted {false}

private

true if the last reference to ThreadPool::Queue goes away

{false}; 

Referenced by deletingQueue(), and jobStarted().

mut

boost::mutex Scroom::Detail::ThreadPool::QueueImpl::mut

private

Guard internal data

Referenced by deletingQueue(), getCount(), jobFinished(), and jobStarted().

---

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

• libs/threadpool/src/queue.hh
• libs/threadpool/src/queue.cc