concurrent_queue< XDataType > Class Template Reference

#include <concurrent_queue.hh>

Classes
struct	queue_not_empty

Public Types
typedef std::deque< XDataType >	queue
typedef std::unique_lock< std::mutex >	cq_lock

Public Member Functions
	concurrent_queue ()
virtual	~concurrent_queue ()
void	push (XDataType const &a_data)
bool	empty () const
uint	size () const
bool	try_pop (XDataType &a_popped_value)
bool	wait_and_pop (XDataType &a_popped_value)
bool	timed_wait_and_pop (XDataType &a_popped_value)
void	interrupt ()
unsigned	get_timeout () const
void	set_timeout (unsigned a_duration)

Private Attributes
queue	f_queue
bool	f_interrupt
std::chrono::milliseconds	f_timeout
std::mutex	f_mutex
	Timeout duration in milliseconds. More...
std::condition_variable	f_condition_var

Detailed Description

template<class XDataType>
class scarab::concurrent_queue< XDataType >

Definition at line 30 of file concurrent_queue.hh.

Member Typedef Documentation

typedef std::unique_lock< std::mutex > cq_lock

Definition at line 47 of file concurrent_queue.hh.

typedef std::deque< XDataType > queue

Definition at line 33 of file concurrent_queue.hh.

Constructor & Destructor Documentation

concurrent_queue ( )

inline

Definition at line 50 of file concurrent_queue.hh.

virtual ~concurrent_queue ( )

inlinevirtual

Definition at line 59 of file concurrent_queue.hh.

Member Function Documentation

bool empty ( ) const

inline

Definition at line 85 of file concurrent_queue.hh.

unsigned get_timeout ( ) const

inline

Definition at line 157 of file concurrent_queue.hh.

void interrupt ( )

inline

Definition at line 150 of file concurrent_queue.hh.

void push ( XDataType const &  a_data )

inline

Definition at line 74 of file concurrent_queue.hh.

void set_timeout ( unsigned  a_duration )

inline

Definition at line 162 of file concurrent_queue.hh.

uint size ( ) const

inline

Definition at line 91 of file concurrent_queue.hh.

bool timed_wait_and_pop ( XDataType &  a_popped_value )

inline

Definition at line 128 of file concurrent_queue.hh.

bool try_pop ( XDataType &  a_popped_value )

inline

Definition at line 97 of file concurrent_queue.hh.

bool wait_and_pop ( XDataType &  a_popped_value )

inline

Definition at line 111 of file concurrent_queue.hh.

Member Data Documentation

std::condition_variable f_condition_var

private

Definition at line 71 of file concurrent_queue.hh.

bool f_interrupt

private

Definition at line 66 of file concurrent_queue.hh.

std::mutex f_mutex

mutableprivate

Timeout duration in milliseconds.

Definition at line 70 of file concurrent_queue.hh.

queue f_queue

private

Definition at line 65 of file concurrent_queue.hh.

std::chrono::milliseconds f_timeout

private

Definition at line 68 of file concurrent_queue.hh.

---

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

• concurrent_queue.hh