synchronized_queue< T, max_len > Class Template Reference

simple blocking synchronized queue More...

#include <synchronized_queue.h>

Inheritance diagram for synchronized_queue< T, max_len >:

Collaboration diagram for synchronized_queue< T, max_len >:

Public Member Functions
T	pop (bool nonblocking=false)
void	push (T &&message)
void	push (T const &message)
int	size ()
template<typename Rep , typename Period >
bool	timed_pop (T &result, std::chrono::duration< Rep, Period > const &timeout)

Private Attributes
std::mutex	m_lock
std::queue< T >	m_queue
std::condition_variable	m_queue_decremented
std::condition_variable	m_queue_incremented

Detailed Description

template<typename T = struct msg *, int max_len = 1>
class synchronized_queue< T, max_len >

simple blocking synchronized queue

Queue blocks if it size is higher than max_len on push. It also blocks on pop call if there is no element in the queue.

Template Parameters

T	type to be stored
max_len	maximal length of the queue until it bloks (-1 means unlimited)

Definition at line 62 of file synchronized_queue.h.

Member Function Documentation

pop()

template<typename T = struct msg *, int max_len = 1>

T synchronized_queue< T, max_len >::pop ( bool nonblocking = false )

inline

Definition at line 92 of file synchronized_queue.h.

        {
                std::unique_lock<std::mutex> l(m_lock);
                if (m_queue.size() == 0 && nonblocking) {
                        return T();
                }
 
                m_queue_incremented.wait(l, [this]{return m_queue.size() > 0;});
                T ret = std::move(m_queue.front());
                m_queue.pop();
 
                l.unlock();
                m_queue_decremented.notify_one();
                return ret;
        }

References synchronized_queue< T, max_len >::m_lock, synchronized_queue< T, max_len >::m_queue, synchronized_queue< T, max_len >::m_queue_decremented, and synchronized_queue< T, max_len >::m_queue_incremented.

Referenced by compress_pop(), decode_video_frame(), decompress_thread(), and fec_thread().

push() [1/2]

template<typename T = struct msg *, int max_len = 1>

void synchronized_queue< T, max_len >::push ( T && message )

inline

Definition at line 81 of file synchronized_queue.h.

        {
                std::unique_lock<std::mutex> l(m_lock);
                if (max_len != -1) {
                        m_queue_decremented.wait(l, [this]{return m_queue.size() < (unsigned int) max_len;});
                }
                m_queue.push(std::move(message));
                l.unlock();
                m_queue_incremented.notify_one();
        }

References synchronized_queue< T, max_len >::m_lock, synchronized_queue< T, max_len >::m_queue, synchronized_queue< T, max_len >::m_queue_decremented, and synchronized_queue< T, max_len >::m_queue_incremented.

push() [2/2]

template<typename T = struct msg *, int max_len = 1>

void synchronized_queue< T, max_len >::push ( T const & message )

inline

Definition at line 70 of file synchronized_queue.h.

        {
                std::unique_lock<std::mutex> l(m_lock);
                if (max_len != -1) {
                        m_queue_decremented.wait(l, [this]{return m_queue.size() < (unsigned int) max_len;});
                }
                m_queue.push(message);
                l.unlock();
                m_queue_incremented.notify_one();
        }

References synchronized_queue< T, max_len >::m_lock, synchronized_queue< T, max_len >::m_queue, synchronized_queue< T, max_len >::m_queue_decremented, and synchronized_queue< T, max_len >::m_queue_incremented.

Referenced by compress_frame(), decode_video_frame(), decompress_thread(), fec_thread(), and video_decoder_stop_threads().

size()

template<typename T = struct msg *, int max_len = 1>

int synchronized_queue< T, max_len >::size ( )

inline

Definition at line 64 of file synchronized_queue.h.

        {
                std::unique_lock<std::mutex> l(m_lock);
                return m_queue.size();
        }

References synchronized_queue< T, max_len >::m_lock, and synchronized_queue< T, max_len >::m_queue.

timed_pop()

template<typename T = struct msg *, int max_len = 1>

template<typename Rep , typename Period >

bool synchronized_queue< T, max_len >::timed_pop ( T & result, std::chrono::duration< Rep, Period > const & timeout )

inline

Definition at line 109 of file synchronized_queue.h.

        {
                std::unique_lock<std::mutex> l(m_lock);
                if (!m_queue_incremented.wait_for(l, timeout, [this]{return m_queue.size() > 0;})) {
                        return false;
                }
                result = std::move(m_queue.front());
                m_queue.pop();
                l.unlock();
                m_queue_decremented.notify_one();
                return true;
        }

References synchronized_queue< T, max_len >::m_lock, synchronized_queue< T, max_len >::m_queue, synchronized_queue< T, max_len >::m_queue_decremented, and synchronized_queue< T, max_len >::m_queue_incremented.

Member Data Documentation

m_lock

template<typename T = struct msg *, int max_len = 1>

std::mutex synchronized_queue< T, max_len >::m_lock

private

Definition at line 124 of file synchronized_queue.h.

Referenced by synchronized_queue< T, max_len >::pop(), synchronized_queue< T, max_len >::push(), synchronized_queue< T, max_len >::push(), synchronized_queue< T, max_len >::size(), and synchronized_queue< T, max_len >::timed_pop().

m_queue

template<typename T = struct msg *, int max_len = 1>

std::queue<T> synchronized_queue< T, max_len >::m_queue

private

Definition at line 123 of file synchronized_queue.h.

Referenced by synchronized_queue< T, max_len >::pop(), synchronized_queue< T, max_len >::push(), synchronized_queue< T, max_len >::push(), synchronized_queue< T, max_len >::size(), and synchronized_queue< T, max_len >::timed_pop().

m_queue_decremented

template<typename T = struct msg *, int max_len = 1>

std::condition_variable synchronized_queue< T, max_len >::m_queue_decremented

private

Definition at line 125 of file synchronized_queue.h.

Referenced by synchronized_queue< T, max_len >::pop(), synchronized_queue< T, max_len >::push(), synchronized_queue< T, max_len >::push(), and synchronized_queue< T, max_len >::timed_pop().

m_queue_incremented

template<typename T = struct msg *, int max_len = 1>

std::condition_variable synchronized_queue< T, max_len >::m_queue_incremented

private

Definition at line 126 of file synchronized_queue.h.

Referenced by synchronized_queue< T, max_len >::pop(), synchronized_queue< T, max_len >::push(), synchronized_queue< T, max_len >::push(), and synchronized_queue< T, max_len >::timed_pop().

---

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

• src/utils/synchronized_queue.h