ProducerConsumerQueue< T > Class Template Reference

#include <ProducerConsumerQueue.h>

Public Member Functions
	ProducerConsumerQueue ()
void	Push (const T &value)
bool	Empty ()
bool	Pop (T &value)
void	WaitAndPop (T &value)
void	Cancel ()

Private Member Functions
template<typename E = T>
std::enable_if < std::is_pointer< E >::value > ::type	DeleteQueuedObject (E &obj)
template<typename E = T>
std::enable_if <!std::is_pointer< E >::value > ::type	DeleteQueuedObject (E const &)

Private Attributes
std::mutex	_queueLock
std::queue< T >	_queue
std::condition_variable	_condition
std::atomic< bool >	_shutdown

Constructor & Destructor Documentation

template<typename T>

ProducerConsumerQueue< T >::ProducerConsumerQueue ( )

inline

: _shutdown(false) { }

Member Function Documentation

template<typename T>

void ProducerConsumerQueue< T >::Cancel ( )

inline

 {
 std::unique_lock<std::mutex> lock(_queueLock);

 while (!_queue.empty())
 {
 T& value = _queue.front();

 DeleteQueuedObject(value);

 _queue.pop();
 }

 _shutdown = true;

 _condition.notify_all();
 }

Here is the caller graph for this function:

template<typename T>

template<typename E = T>

std::enable_if<std::is_pointer<E>::value>::type ProducerConsumerQueue< T >::DeleteQueuedObject ( E &  obj )

inlineprivate

{ delete obj; }

Here is the caller graph for this function:

template<typename T>

template<typename E = T>

std::enable_if<!std::is_pointer<E>::value>::type ProducerConsumerQueue< T >::DeleteQueuedObject ( E const &  )

inlineprivate

{ }

template<typename T>

bool ProducerConsumerQueue< T >::Empty ( )

inline

 {
 std::lock_guard<std::mutex> lock(_queueLock);

 return _queue.empty();
 }

Here is the caller graph for this function:

template<typename T>

bool ProducerConsumerQueue< T >::Pop ( T &  value )

inline

 {
 std::lock_guard<std::mutex> lock(_queueLock);

 if (_queue.empty() || _shutdown)
 return false;

 value = _queue.front();

 _queue.pop();

 return true;
 }

template<typename T>

void ProducerConsumerQueue< T >::Push ( const T &  value )

inline

 {
 std::lock_guard<std::mutex> lock(_queueLock);
 _queue.push(std::move(value));

 _condition.notify_one();
 }

Here is the caller graph for this function:

template<typename T>

void ProducerConsumerQueue< T >::WaitAndPop ( T &  value )

inline

 {
 std::unique_lock<std::mutex> lock(_queueLock);

 // we could be using .wait(lock, predicate) overload here but it is broken
 // https://connect.microsoft.com/VisualStudio/feedback/details/1098841
 while (_queue.empty() && !_shutdown)
 _condition.wait(lock);

 if (_queue.empty() || _shutdown)
 return;

 value = _queue.front();

 _queue.pop();
 }

Here is the caller graph for this function:

Member Data Documentation

template<typename T>

std::condition_variable ProducerConsumerQueue< T >::_condition

private

template<typename T>

std::queue<T> ProducerConsumerQueue< T >::_queue

private

template<typename T>

std::mutex ProducerConsumerQueue< T >::_queueLock

private

template<typename T>

std::atomic<bool> ProducerConsumerQueue< T >::_shutdown

private

---

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

• src/common/Threading/ProducerConsumerQueue.h