BlockingQueue< T > Class Template Reference

BlockingQueue Class. More...

#include <BlockingQueue.h>

Inheritance diagram for BlockingQueue< T >:

Collaboration diagram for BlockingQueue< T >:

Public Member Functions
void	Push (T toPush)
T	Pop ()
bool	IsEmpty ()
int	Size ()

Detailed Description

template<typename T>
class BlockingQueue< T >

BlockingQueue Class.

Class to wrap around std::deque and block thread execution when no data is available at the output.

Template Parameters

T	Type of elements in the queue

Definition at line 23 of file BlockingQueue.h.

Member Function Documentation

IsEmpty()

template<typename T >

bool BlockingQueue< T >::IsEmpty

Template Parameters

T

Returns

true if internal queue empty, false otherwise

Definition at line 24 of file BlockingQueue.cpp.

                              {
    return internalQueue.empty();
}

Pop()

template<typename T >

T BlockingQueue< T >::Pop

Pop method, uses mutex lock to sleep the current thread until data are available on the queue. This may be used to synchonise and schedule threads.

Template Parameters

T

Returns

Element on deque back

Definition at line 11 of file BlockingQueue.cpp.

                        {
    std::unique_lock<std::mutex> lock(mutex);
    condition.wait(lock, [=]{ return !internalQueue.empty(); });
    T ret = internalQueue.back();
    internalQueue.pop_back();
    return ret;
}

Push()

template<typename T >

void BlockingQueue< T >::Push

(

T

toPush

)

adds element to the queue.

Template Parameters

T

Parameters

toPush

Definition at line 44 of file BlockingQueue.cpp.

                                    {
    {
        internalQueue.push_front(toPush);
    }
    condition.notify_all();
}

Size()

template<typename T >

int BlockingQueue< T >::Size

Gets the current length of elements in the queue.

Template Parameters

T

Returns

size of internal deque

Definition at line 34 of file BlockingQueue.cpp.

                          {
    return internalQueue.size();
}

---

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

• src/BlockingQueue.h
• src/BlockingQueue.cpp