bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE > Class Template Reference

#include <bdlcc_singleproducersingleconsumerboundedqueue.h>

Public Types
enum	{   e_SUCCESS = 0 , e_EMPTY = -1 , e_FULL = -2 , e_DISABLED = -3 ,   e_FAILED = -4 }
typedef TYPE	value_type

Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (SingleProducerSingleConsumerBoundedQueue, bslma::UsesBslmaAllocator)
	SingleProducerSingleConsumerBoundedQueue (bsl::size_t capacity, bslma::Allocator *basicAllocator=0)
	~SingleProducerSingleConsumerBoundedQueue ()
	Destroy this object.
int	popFront (TYPE *value)
int	pushBack (const TYPE &value)
int	pushBack (bslmf::MovableRef< TYPE > value)
void	removeAll ()
int	tryPopFront (TYPE *value)
int	tryPushBack (const TYPE &value)
int	tryPushBack (bslmf::MovableRef< TYPE > value)
void	disablePopFront ()
void	disablePushBack ()
void	enablePushBack ()
void	enablePopFront ()
bsl::size_t	capacity () const
bool	isEmpty () const
bool	isFull () const
bool	isPopFrontDisabled () const
bool	isPushBackDisabled () const
bsl::size_t	numElements () const
	Returns the number of elements currently in this queue.
int	waitUntilEmpty () const
bslma::Allocator *	allocator () const
	Return the allocator used by this object to supply memory.

Friends
class	SingleProducerSingleConsumerBoundedQueue_PopCompleteGuard< SingleProducerSingleConsumerBoundedQueue< TYPE >, typename SingleProducerSingleConsumerBoundedQueue< TYPE >::Node >

Member Typedef Documentation

value_type

template<class TYPE >

typedef TYPE bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::value_type

Member Enumeration Documentation

anonymous enum

template<class TYPE >

anonymous enum

Enumerator
e_SUCCESS
e_EMPTY
e_FULL
e_DISABLED
e_FAILED

Constructor & Destructor Documentation

SingleProducerSingleConsumerBoundedQueue()

template<class TYPE >

bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::SingleProducerSingleConsumerBoundedQueue ( bsl::size_t  capacity, bslma::Allocator *  basicAllocator = 0  )

explicit

Create a thread-aware queue with at least the specified capacity. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

~SingleProducerSingleConsumerBoundedQueue()

template<class TYPE >

bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::~SingleProducerSingleConsumerBoundedQueue

(

)

Member Function Documentation

allocator()

template<class TYPE >

bslma::Allocator * bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::allocator ( ) const

inline

BSLMF_NESTED_TRAIT_DECLARATION()

template<class TYPE >

bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::BSLMF_NESTED_TRAIT_DECLARATION	(	SingleProducerSingleConsumerBoundedQueue< TYPE >	,
		bslma::UsesBslmaAllocator
	)

capacity()

template<class TYPE >

bsl::size_t bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::capacity ( ) const

inline

Return the maximum number of elements that may be stored in this queue. Note that the value returned may be greater than that supplied at construction.

disablePopFront()

template<class TYPE >

void bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::disablePopFront ( )

inline

Disable dequeueing from this queue. All subsequent invocations of popFront or tryPopFront will fail immediately. If the single consumer is blocked in popFront, the invocation of popFront will fail immediately. Any blocked invocations of waitUntilEmpty will fail immediately. If the queue is already dequeue disabled, this method has no effect.

disablePushBack()

template<class TYPE >

void bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::disablePushBack ( )

inline

Disable enqueueing into this queue. All subsequent invocations of pushBack or tryPushBack will fail immediately. If the single producer is blocked in pushBack, the invocation of pushBack will fail immediately. If the queue is already enqueue disabled, this method has no effect.

enablePopFront()

template<class TYPE >

void bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::enablePopFront ( )

inline

Enable dequeueing. If the queue is not dequeue disabled, this call has no effect.

enablePushBack()

template<class TYPE >

void bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::enablePushBack ( )

inline

Enable queuing. If the queue is not enqueue disabled, this call has no effect.

isEmpty()

template<class TYPE >

bool bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::isEmpty ( ) const

inline

Return true if this queue is empty (has no elements), or false otherwise.

isFull()

template<class TYPE >

bool bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::isFull ( ) const

inline

Return true if this queue is full (has no available capacity), or false otherwise.

isPopFrontDisabled()

template<class TYPE >

bool bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::isPopFrontDisabled ( ) const

inline

Return true if this queue is dequeue disabled, and false otherwise. Note that the queue is created in the "dequeue enabled" state.

isPushBackDisabled()

template<class TYPE >

bool bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::isPushBackDisabled ( ) const

inline

Return true if this queue is enqueue disabled, and false otherwise. Note that the queue is created in the "enqueue enabled" state.

numElements()

template<class TYPE >

bsl::size_t bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::numElements ( ) const

inline

popFront()

template<class TYPE >

int bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::popFront ( TYPE *  value )

inline

Remove the element from the front of this queue and load that element into the specified value. If the queue is empty, block until it is not empty. Return 0 on success, and a non-zero value otherwise. Specifically, return e_SUCCESS on success, e_DISABLED if isPopFrontDisabled() and e_FAILED if an underlying mechanism returns an error. On failure, value is not changed. Threads blocked due to the queue being empty will return e_DISABLED if disablePopFront is invoked. The behavior is undefined unless the invoker of this method is the single consumer.

pushBack() [1/2]

template<class TYPE >

int bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::pushBack ( bslmf::MovableRef< TYPE >  value )

inline

Append the specified move-insertable value to the back of this queue. value is left in a valid but unspecified state. Return 0 on success, and a non-zero value otherwise. Specifically, return e_SUCCESS on success, e_DISABLED if isPushBackDisabled() and e_FAILED if an underlying mechanism returns an error. On failure, value is not changed. Threads blocked due to the queue being full will return e_DISABLED if disablePushFront is invoked. The behavior is undefined unless the invoker of this method is the single producer.

pushBack() [2/2]

template<class TYPE >

int bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::pushBack ( const TYPE &  value )

inline

Append the specified value to the back of this queue. Return 0 on success, and a non-zero value otherwise. Specifically, return e_SUCCESS on success, e_DISABLED if isPushBackDisabled() and e_FAILED if an underlying mechanism returns an error. Threads blocked due to the queue being full will return e_DISABLED if disablePushFront is invoked. The behavior is undefined unless the invoker of this method is the single producer.

removeAll()

template<class TYPE >

void bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::removeAll

(

)

Remove all items currently in this queue. Note that this operation is not atomic; if other threads are concurrently pushing items into the queue the result of numElements() after this function returns is not guaranteed to be 0. The behavior is undefined unless the invoker of this method is the single consumer.

tryPopFront()

template<class TYPE >

int bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::tryPopFront ( TYPE *  value )

inline

Attempt to remove the element from the front of this queue without blocking, and, if successful, load the specified value with the removed element. Return 0 on success, and a non-zero value otherwise. Specifically, return e_SUCCESS on success, e_DISABLED if isPopFrontDisabled(), and e_EMPTY if !isPopFrontDisabled() and the queue was empty. On failure, value is not changed. The behavior is undefined unless the invoker of this method is the single consumer.

tryPushBack() [1/2]

template<class TYPE >

int bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::tryPushBack ( bslmf::MovableRef< TYPE >  value )

inline

Append the specified move-insertable value to the back of this queue. value is left in a valid but unspecified state. Return 0 on success, and a non-zero value otherwise. Specifically, return e_SUCCESS on success, e_DISABLED if isPushBackDisabled(), and e_FULL if !isPushBackDisabled() and the queue was full. On failure, value is not changed. The behavior is undefined unless the invoker of this method is the single producer.

tryPushBack() [2/2]

template<class TYPE >

int bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::tryPushBack ( const TYPE &  value )

inline

Append the specified value to the back of this queue. Return 0 on success, and a non-zero value otherwise. Specifically, return e_SUCCESS on success, e_DISABLED if isPushBackDisabled(), and e_FULL if !isPushBackDisabled() and the queue was full. The behavior is undefined unless the invoker of this method is the single producer.

waitUntilEmpty()

template<class TYPE >

int bdlcc::SingleProducerSingleConsumerBoundedQueue< TYPE >::waitUntilEmpty

(

)

const

Block until all the elements in this queue are removed. Return 0 on success, and a non-zero value otherwise. Specifically, return e_SUCCESS on success, e_DISABLED if isPopFrontDisabled() and e_FAILED if an underlying mechanism returns an error. A blocked thread waiting for the queue to empty will return a non-zero value if disablePopFront is invoked.

Friends And Related Symbol Documentation

SingleProducerSingleConsumerBoundedQueue_PopCompleteGuard< SingleProducerSingleConsumerBoundedQueue< TYPE >, typename SingleProducerSingleConsumerBoundedQueue< TYPE >::Node >

template<class TYPE >

friend class SingleProducerSingleConsumerBoundedQueue_PopCompleteGuard< SingleProducerSingleConsumerBoundedQueue< TYPE >, typename SingleProducerSingleConsumerBoundedQueue< TYPE >::Node >

friend

---

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

• bdlcc_singleproducersingleconsumerboundedqueue.h