BDE 4.14.0 Production release
Loading...
Searching...
No Matches
bdlcc::BoundedQueue< TYPE > Class Template Reference

#include <bdlcc_boundedqueue.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 (BoundedQueue, bslma::UsesBslmaAllocator)
 
 BoundedQueue (bsl::size_t capacity, bslma::Allocator *basicAllocator=0)
 
 ~BoundedQueue ()
 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 enablePopFront ()
 
void enablePushBack ()
 
bsl::size_t capacity () const
 
bool isEmpty () const
 
bool isFull () const
 
bool isPopFrontDisabled () const
 
bool isPushBackDisabled () const
 
bsl::size_t numElements () const
 
int waitUntilEmpty () const
 
bslma::Allocatorallocator () const
 Return the allocator used by this object to supply memory.
 

Friends

class BoundedQueue_PopCompleteGuard< BoundedQueue< TYPE >, typename BoundedQueue< TYPE >::Node >
 
class BoundedQueue_PushExceptionCompleteProctor< BoundedQueue< TYPE > >
 

Detailed Description

template<class TYPE>
class bdlcc::BoundedQueue< TYPE >

This class provides a thread-safe bounded queue of values.

See bdlcc_boundedqueue

Member Typedef Documentation

◆ value_type

template<class TYPE >
typedef TYPE bdlcc::BoundedQueue< 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

◆ BoundedQueue()

template<class TYPE >
bdlcc::BoundedQueue< TYPE >::BoundedQueue ( 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.

◆ ~BoundedQueue()

template<class TYPE >
bdlcc::BoundedQueue< TYPE >::~BoundedQueue ( )

Member Function Documentation

◆ allocator()

template<class TYPE >
bslma::Allocator * bdlcc::BoundedQueue< TYPE >::allocator ( ) const
inline

◆ BSLMF_NESTED_TRAIT_DECLARATION()

template<class TYPE >
bdlcc::BoundedQueue< TYPE >::BSLMF_NESTED_TRAIT_DECLARATION ( BoundedQueue< TYPE >  ,
bslma::UsesBslmaAllocator   
)

◆ capacity()

template<class TYPE >
bsl::size_t bdlcc::BoundedQueue< 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::BoundedQueue< TYPE >::disablePopFront ( )
inline

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

◆ disablePushBack()

template<class TYPE >
void bdlcc::BoundedQueue< TYPE >::disablePushBack ( )
inline

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

◆ enablePopFront()

template<class TYPE >
void bdlcc::BoundedQueue< TYPE >::enablePopFront ( )
inline

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

◆ enablePushBack()

template<class TYPE >
void bdlcc::BoundedQueue< TYPE >::enablePushBack ( )
inline

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

◆ isEmpty()

template<class TYPE >
bool bdlcc::BoundedQueue< TYPE >::isEmpty ( ) const
inline

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

◆ isFull()

template<class TYPE >
bool bdlcc::BoundedQueue< TYPE >::isFull ( ) const
inline

Return true if this queue is full (has no available capacity), or false otherwise. Note that for unbounded queues, this method always returns false.

◆ isPopFrontDisabled()

template<class TYPE >
bool bdlcc::BoundedQueue< 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::BoundedQueue< 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::BoundedQueue< TYPE >::numElements ( ) const
inline

Returns the number of elements currently in this queue. Note that numElements() == capacity() is not a valid replacement for isFull (see {Exception Safety} for details).

◆ popFront()

template<class TYPE >
int bdlcc::BoundedQueue< 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 error occurs. On failure, value is not changed. Threads blocked due to the queue being empty will return e_DISABLED if disablePopFront is invoked.

◆ pushBack() [1/2]

template<class TYPE >
int bdlcc::BoundedQueue< TYPE >::pushBack ( bslmf::MovableRef< TYPE >  value)

Append the specified move-insertable value to the back of this queue. If the queue is full, block until it is not full. 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 error occurs. On failure, value is not changed. Threads blocked due to the queue being full will return e_DISABLED if disablePushBack is invoked.

◆ pushBack() [2/2]

template<class TYPE >
int bdlcc::BoundedQueue< TYPE >::pushBack ( const TYPE &  value)

Append the specified value to the back of this queue. If the queue is full, block until it is not full. 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 error occurs. Threads blocked due to the queue being full will return e_DISABLED if disablePushBack is invoked.

◆ removeAll()

template<class TYPE >
void bdlcc::BoundedQueue< 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.

◆ tryPopFront()

template<class TYPE >
int bdlcc::BoundedQueue< 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(), e_EMPTY if !isPopFrontDisabled() and the queue was empty, and e_FAILED if an error occurs. On failure, value is not changed.

◆ tryPushBack() [1/2]

template<class TYPE >
int bdlcc::BoundedQueue< TYPE >::tryPushBack ( bslmf::MovableRef< TYPE >  value)

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(), e_FULL if !isPushBackDisabled() and the queue was full, and e_FAILED if an error occurs. On failure, value is not changed.

◆ tryPushBack() [2/2]

template<class TYPE >
int bdlcc::BoundedQueue< TYPE >::tryPushBack ( const TYPE &  value)

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(), e_FULL if !isPushBackDisabled() and the queue was full, and e_FAILED if an error occurs.

◆ waitUntilEmpty()

template<class TYPE >
int bdlcc::BoundedQueue< 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 !isEmpty() && isPopFrontDisabled(). A blocked thread waiting for the queue to empty will return e_DISABLED if disablePopFront is invoked.

Friends And Related Symbol Documentation

◆ BoundedQueue_PopCompleteGuard< BoundedQueue< TYPE >, typename BoundedQueue< TYPE >::Node >

template<class TYPE >
friend class BoundedQueue_PopCompleteGuard< BoundedQueue< TYPE >, typename BoundedQueue< TYPE >::Node >
friend

◆ BoundedQueue_PushExceptionCompleteProctor< BoundedQueue< TYPE > >

template<class TYPE >
friend class BoundedQueue_PushExceptionCompleteProctor< BoundedQueue< TYPE > >
friend

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