waitQueues::ordered< T, ascending, Container > Class Template Reference

#include <waitQueues.h>

Collaboration diagram for waitQueues::ordered< T, ascending, Container >:

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

Private Attributes
Container	queue
std::mutex	queue_mutex
std::condition_variable	cv

Detailed Description

template<typename T, bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>
class waitQueues::ordered< T, ascending, Container >

Definition at line 133 of file waitQueues.h.

Member Function Documentation

dequeue() [1/2]

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

std::unique_ptr<T> waitQueues::ordered< T, ascending, Container >::dequeue ( )

inline

Definition at line 178 of file waitQueues.h.

                               {
        std::unique_lock<decltype(queue_mutex)> lock(queue_mutex); //(NOLINT clang-analyzer-alpha.core.CastToStruct)
        while (queue.empty()) {
            cv.wait(lock);//(NOLINT clang-analyzer-alpha.core.CastToStruct)
        }
        auto it = queue.begin();
        auto item = *it;
        if (item != nullptr) { // nullptrs are end markers, multiple readers need many of them...
            queue.erase(it);
        }
        return std::unique_ptr<T>(item);
    }

References waitQueues::ordered< T, ascending, Container >::cv, waitQueues::ordered< T, ascending, Container >::queue, and waitQueues::ordered< T, ascending, Container >::queue_mutex.

dequeue() [2/2]

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

template<typename durationType >

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

inline

Definition at line 162 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;
            }
        }
        auto it = queue.begin();
        auto item = *it;
        if (item != nullptr) { // nullptrs are end markers, multiple readers need many of them...
            queue.erase(it);
        }
        return std::unique_ptr<T>(item);
    }

References waitQueues::ordered< T, ascending, Container >::cv, waitQueues::ordered< T, ascending, Container >::queue, and waitQueues::ordered< T, ascending, Container >::queue_mutex.

Referenced by o2s().

Here is the caller graph for this function:

emplace()

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

template<class ... Types>

void waitQueues::ordered< T, ascending, Container >::emplace ( Types ...  args )

inline

Definition at line 148 of file waitQueues.h.

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

References waitQueues::ordered< T, ascending, Container >::enqueue().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

empty()

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

decltype(queue.empty()) waitQueues::ordered< T, ascending, Container >::empty ( ) const

inline

Definition at line 204 of file waitQueues.h.

                                          {
        return queue.empty();
    }

References waitQueues::ordered< T, ascending, Container >::queue.

enqueue()

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

void waitQueues::ordered< T, ascending, Container >::enqueue ( std::unique_ptr< T > &  item )

inline

Definition at line 139 of file waitQueues.h.

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

References waitQueues::ordered< T, ascending, Container >::cv, waitQueues::ordered< T, ascending, Container >::queue, and waitQueues::ordered< T, ascending, Container >::queue_mutex.

Referenced by waitQueues::ordered< T, ascending, Container >::emplace(), main(), and waitQueues::ordered< T, ascending, Container >::signalDone().

Here is the caller graph for this function:

resetDone()

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

void waitQueues::ordered< T, ascending, Container >::resetDone ( )

inline

Definition at line 156 of file waitQueues.h.

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

References waitQueues::ordered< T, ascending, Container >::queue, and waitQueues::ordered< T, ascending, Container >::queue_mutex.

signalDone() [1/2]

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

void waitQueues::ordered< T, ascending, Container >::signalDone ( )

inline

Definition at line 152 of file waitQueues.h.

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

References waitQueues::ordered< T, ascending, Container >::enqueue().

Here is the call graph for this function:

signalDone() [2/2]

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

template<typename iterType >

void waitQueues::ordered< T, ascending, Container >::signalDone ( iterType  begin, iterType  end  )

inline

Definition at line 190 of file waitQueues.h.

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

References waitQueues::ordered< T, ascending, Container >::enqueue().

Here is the call graph for this function:

signalDoneThread()

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

template<typename iterType >

std::thread waitQueues::ordered< T, ascending, Container >::signalDoneThread ( iterType  begin, iterType  end  )

inline

Definition at line 197 of file waitQueues.h.

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

size()

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

decltype(queue.size()) waitQueues::ordered< T, ascending, Container >::size ( ) const

inline

Definition at line 201 of file waitQueues.h.

                                        {
        return queue.size();
    }

References waitQueues::ordered< T, ascending, Container >::queue.

Member Data Documentation

cv

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

std::condition_variable waitQueues::ordered< T, ascending, Container >::cv

private

Definition at line 137 of file waitQueues.h.

Referenced by waitQueues::ordered< T, ascending, Container >::dequeue(), and waitQueues::ordered< T, ascending, Container >::enqueue().

queue

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

Container waitQueues::ordered< T, ascending, Container >::queue

private

Definition at line 135 of file waitQueues.h.

Referenced by waitQueues::ordered< T, ascending, Container >::dequeue(), waitQueues::ordered< T, ascending, Container >::empty(), waitQueues::ordered< T, ascending, Container >::enqueue(), waitQueues::ordered< T, ascending, Container >::resetDone(), and waitQueues::ordered< T, ascending, Container >::size().

queue_mutex

template<typename T , bool ascending = true, typename Container = std::multiset<T*, itemComparator<T, ascending>>>

std::mutex waitQueues::ordered< T, ascending, Container >::queue_mutex

private

Definition at line 136 of file waitQueues.h.

Referenced by waitQueues::ordered< T, ascending, Container >::dequeue(), waitQueues::ordered< T, ascending, Container >::enqueue(), and waitQueues::ordered< T, ascending, Container >::resetDone().

---

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

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