waitQueues::simple< T > Class Template Reference

#include <waitQueues.h>

Collaboration diagram for waitQueues::simple< T >:

Public Member Functions
void	enqueue (std::unique_ptr< T > &item)
template<class ... Types>
void	emplace (Types ... args)
void	signalDone ()
void	resetDone ()
template<class ... Types>
std::unique_ptr< T >	dequeue (bool mayCreateNew, Types ... args)
template<typename durationType >
std::unique_ptr< T >	dequeue (durationType timeout, bool &timedOut)
std::unique_ptr< T >	dequeue ()
decltype(queue.size())	size () const
decltype(queue.empty())	empty () const
template<typename iterType >
void	signalDone (iterType begin, iterType end)
template<typename iterType >
std::thread	signalDoneThread (iterType begin, iterType end)

Private Attributes
std::deque< std::unique_ptr< T > >	queue
std::mutex	queue_mutex
std::condition_variable	cv

Detailed Description

template<typename T>
class waitQueues::simple< T >

Definition at line 31 of file waitQueues.h.

Member Function Documentation

dequeue() [1/3]

template<typename T >

std::unique_ptr<T> waitQueues::simple< T >::dequeue ( )

inline

Definition at line 88 of file waitQueues.h.

                                   {
            std::unique_lock<decltype(queue_mutex)> lock(queue_mutex);
            while (queue.empty()) {
                cv.wait(lock);
            }
            auto item = std::move(queue.front());
            if (item) { // nullptrs are end markers, multiple readers need many of them...
                queue.pop_front();
            }
            return item;
        }

dequeue() [2/3]

template<typename T >

template<class ... Types>

std::unique_ptr<T> waitQueues::simple< T >::dequeue ( bool  mayCreateNew, Types ...  args  )

inline

Definition at line 59 of file waitQueues.h.

                                                                                               {
            std::unique_lock<decltype(queue_mutex)> lock(queue_mutex); //(NOLINT clang-analyzer-alpha.core.CastToStruct)
            while (queue.empty()) {
                if (mayCreateNew) {
                    return std::unique_ptr<T>(new T(args...));
                }
                cv.wait(lock);
            }
            auto item = std::move(queue.front());
            if (item) { // nullptrs are end markers, multiple readers need many of them...
                queue.pop_front();
            }
            return item;
        }

Referenced by copyRequest::base::hash_worker(), copyRequest::base::hasher(), main(), printResults(), copyRequest::base::processQueue(), copyRequest::base::reader(), copyRequest::base::readWorker(), copyRequest::base::writer(), and copyRequest::base::writeWorker().

Here is the caller graph for this function:

dequeue() [3/3]

template<typename T >

template<typename durationType >

std::unique_ptr<T> waitQueues::simple< T >::dequeue ( durationType  timeout, bool &  timedOut  )

inline

Definition at line 73 of file waitQueues.h.

                                                                                                        {
            std::unique_lock<decltype(queue_mutex)> lock(queue_mutex);
            while (queue.empty()) {
                if (cv.wait_for(lock, timeout) == std::cv_status::timeout) {
                    timedOut = true;
                    return nullptr;
                }
            }
            std::unique_ptr<T> item(std::move(queue.front()));
            if (item) { // nullptrs are end markers, multiple readers need many of them...
                queue.pop_front();
            }
            timedOut = false;
            return item;
        }

emplace()

template<typename T >

template<class ... Types>

void waitQueues::simple< T >::emplace ( Types ...  args )

inline

Definition at line 45 of file waitQueues.h.

                                                                {
            std::unique_ptr<T> item(new T(args...));
            enqueue(item);
        }

Referenced by copyRequest::base::reader().

Here is the caller graph for this function:

empty()

template<typename T >

decltype(queue.empty()) waitQueues::simple< T >::empty ( ) const

inline

Definition at line 102 of file waitQueues.h.

                                              {
            return queue.empty();
        }

enqueue()

template<typename T >

void waitQueues::simple< T >::enqueue ( std::unique_ptr< T > &  item )

inline

Definition at line 37 of file waitQueues.h.

                                             {
            std::unique_lock<decltype(queue_mutex)> lock(queue_mutex); //(NOLINT clang-analyzer-alpha.core.CastToStruct)
            if (!queue.empty() && queue.back() == nullptr) {
                throw std::logic_error("after adding a nullptr no further stuff may be added to a wait queue");
            }
            queue.emplace_back(std::move(item));
            cv.notify_all();
        }

Referenced by delayRequest(), waitQueues::simple< block >::emplace(), followRequestProvider::enqueueOrAppend(), copyRequest::base::hash_worker(), copyRequest::base::hasher(), o2s(), copyRequest::base::processQueue(), moveRequestProvider::processSources(), noFollowRequestProvider::processSources(), copyRequest::base::reader(), copyRequest::base::readWorker(), waitQueues::simple< block >::signalDone(), copyRequest::base::writer(), and copyRequest::base::writeWorker().

Here is the caller graph for this function:

resetDone()

template<typename T >

void waitQueues::simple< T >::resetDone ( )

inline

Definition at line 53 of file waitQueues.h.

                         {
            std::unique_lock<decltype(queue_mutex)> lock(queue_mutex); //(NOLINT clang-analyzer-alpha.core.CastToStruct)
            while (!queue.empty() && queue.back() == nullptr) {
                queue.pop_back();
            }
        }

signalDone() [1/2]

template<typename T >

void waitQueues::simple< T >::signalDone ( )

inline

Definition at line 49 of file waitQueues.h.

                          {
            std::unique_ptr<T> end(nullptr);
            enqueue(end);
        }

Referenced by copyRequest::base::reader(), and waitQueues::simple< block >::signalDone().

Here is the caller graph for this function:

signalDone() [2/2]

template<typename T >

template<typename iterType >

void waitQueues::simple< T >::signalDone ( iterType  begin, iterType  end  )

inline

Definition at line 105 of file waitQueues.h.

                              {
            for (auto it = begin; it != end; ++it) {
                it->join();
            }
            signalDone();
        }

signalDoneThread()

template<typename T >

template<typename iterType >

std::thread waitQueues::simple< T >::signalDoneThread ( iterType  begin, iterType  end  )

inline

Definition at line 112 of file waitQueues.h.

                              {
            return std::thread(&simple::signalDone<iterType>, this, begin, end);
        }

Referenced by main().

Here is the caller graph for this function:

size()

template<typename T >

decltype(queue.size()) waitQueues::simple< T >::size ( ) const

inline

Definition at line 99 of file waitQueues.h.

                                            {
            return queue.size();
        }

Referenced by printResults(), copyRequest::base::reader(), and copyRequest::base::readWorker().

Here is the caller graph for this function:

Member Data Documentation

cv

template<typename T >

std::condition_variable waitQueues::simple< T >::cv

private

Definition at line 35 of file waitQueues.h.

Referenced by waitQueues::simple< block >::dequeue(), and waitQueues::simple< block >::enqueue().

queue

template<typename T >

std::deque<std::unique_ptr<T> > waitQueues::simple< T >::queue

private

Definition at line 33 of file waitQueues.h.

Referenced by waitQueues::simple< block >::dequeue(), waitQueues::simple< block >::empty(), waitQueues::simple< block >::enqueue(), waitQueues::simple< block >::resetDone(), and waitQueues::simple< block >::size().

queue_mutex

template<typename T >

std::mutex waitQueues::simple< T >::queue_mutex

private

Definition at line 34 of file waitQueues.h.

Referenced by waitQueues::simple< block >::dequeue(), waitQueues::simple< block >::enqueue(), and waitQueues::simple< block >::resetDone().

---

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

• cplusplusgoodies/waitQueues.h (v0.19-24-g0617ca1 with changes)