qpid::sys::BlockingQueue< T > Class Template Reference

A simple blocking queue template. More...

#include <BlockingQueue.h>

Collaboration diagram for qpid::sys::BlockingQueue< T >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

bool pop (T &result, Duration timeout=TIME_INFINITE)
 Pop from the queue, block up to timeout if empty.
pop ()
void push (const T &t)
 Push a value onto the queue.
void close (const ExceptionHolder &ex=ExceptionHolder(new ClosedException()))
 Close the queue.
void open ()
 Open a closed queue.
bool isClosed () const
bool empty () const
size_t size () const


Detailed Description

template<class T>
class qpid::sys::BlockingQueue< T >

A simple blocking queue template.

Definition at line 36 of file BlockingQueue.h.


Member Function Documentation

template<class T>
bool qpid::sys::BlockingQueue< T >::pop ( T &  result,
Duration  timeout = TIME_INFINITE 
) [inline]

Pop from the queue, block up to timeout if empty.

Parameters:
result Set to value popped from queue.
timeout Defaults to infinite.
Returns:
true if result was set, false if queue empty after timeout.

Definition at line 50 of file BlockingQueue.h.

References qpid::sys::Condition::notify(), qpid::sys::BlockingQueue< T >::pop(), and qpid::sys::Waitable::wait().

Referenced by qpid::sys::BlockingQueue< T >::pop().

template<class T>
void qpid::sys::BlockingQueue< T >::close ( const ExceptionHolder ex = ExceptionHolder(new ClosedException())  )  [inline]

Close the queue.

exception to throw to waiting threads. ClosedException by default.

Definition at line 87 of file BlockingQueue.h.

References qpid::sys::Waitable::hasException(), qpid::sys::Condition::notifyAll(), qpid::sys::Waitable::setException(), and qpid::sys::Waitable::waitWaiters().

template<class T>
void qpid::sys::BlockingQueue< T >::open (  )  [inline]

Open a closed queue.

Definition at line 98 of file BlockingQueue.h.

References qpid::sys::Waitable::resetException().


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

Generated on Thu Oct 16 13:38:38 2008 for Qpid by  doxygen 1.5.6