ol::TS_Queue< T > Class Template Reference

Thread safe queue. More...

#include <ts_queue.hpp>

Public Member Functions
	TS_Queue (size_t max_size)
virtual	~TS_Queue ()
	Destructor. More...
void	push (const T &item)
	Write data to TS_Queue. More...
void	push_front (const T &item)
void	push (T &&item)
	Write data to TS_Queue. More...
void	push_back (T &&item)
Optional< T >	pop ()
	Get data. More...
Optional< T >	pop_front ()
Optional< T >	pop_for (const std::chrono::milliseconds &timeout)
	Get data. More...
size_t	size () const
	Take objects count.
bool	empty () const
	Check if TS_Queue is empty.
void	stop ()
	Release all threads waiting in TS_Queue::pop(). More...
void	wait_for_data ()
	Wait until data is available.

Detailed Description

template<typename T>
class ol::TS_Queue< T >

Thread safe queue.

TS_Queue is a thread safe queue based on std::deque. It differs however from default containers: TS_Queue is meant to be used as a pipe. There is one side where one or many threads can safely write and there is other side from where one or many threads can read.

Use TS_Queue::push_back() for writing objects, and TS_Queue::pop_front() for reading objects. TS_Queue has it maximum capacity defined on construction. When TS_Queue is full any attempt of pushing data will cause in wait operation.

Thread which destroys TS_Queue will be suspended until TS_Queue becomes empty. No pushes are allowed at that time.

based on: http://en.wikipedia.org/wiki/Producer-consumer_problem

Constructor & Destructor Documentation

template<typename T >

ol::TS_Queue< T >::TS_Queue ( size_t  max_size )

inline

Constructor.

• max_size maximum size of queue. When TS_Queue exceeds defined size, any write will cause writting thread to wait

template<typename T >

virtual ol::TS_Queue< T >::~TS_Queue ( )

inlinevirtual

Destructor.

Thread destroing TS_Queue will be suspended until TS_Queue becomes empty.

Member Function Documentation

template<typename T >

Optional<T> ol::TS_Queue< T >::pop ( )

inline

Get data.

When there is no data in queue, current thread will wait until data appear. Returned type is Optional which can be empty in one situation: when thread was waiting for data and TS_Queue::stop() or TS_Queue's destructor were called.

template<typename T >

Optional<T> ol::TS_Queue< T >::pop_for ( const std::chrono::milliseconds &  timeout )

inline

Get data.

When there is no data in queue, current thread will wait until data appear.

• timeout - defines how long pop_for will wait for new data.

  Returns

  Optional which can be empty in two situations:

  • thread was waiting for data and TS_Queue::stop() or TS_Queue's destructor were called.
  • timeout occured.

template<typename T >

void ol::TS_Queue< T >::push ( const T &  item )

inline

Write data to TS_Queue.

When queue is full, current thread will be suspended until some data is consumed by reader(s). No writes are allowed when TS_Queue is being destroyed.

template<typename T >

void ol::TS_Queue< T >::push ( T &&  item )

inline

Write data to TS_Queue.

Behaves as TS_Queue::push(const T &), but uses move semantics

template<typename T >

void ol::TS_Queue< T >::stop ( )

inline

Release all threads waiting in TS_Queue::pop().

No writes allowed since this moment.

---

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

• src/putils/ts_queue.hpp