|
Quick Links: |
#include <bdlcc_singleconsumerqueue.h>
Public Types | |
| enum | { e_SUCCESS = Impl::e_SUCCESS, e_EMPTY = Impl::e_EMPTY, e_DISABLED = Impl::e_DISABLED } |
| typedef TYPE | value_type |
Public Member Functions | |
| BSLMF_NESTED_TRAIT_DECLARATION (SingleConsumerQueue, bslma::UsesBslmaAllocator) | |
| SingleConsumerQueue (bslma::Allocator *basicAllocator=0) | |
| SingleConsumerQueue (bsl::size_t capacity, bslma::Allocator *basicAllocator=0) | |
| ~SingleConsumerQueue () | |
| 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 () |
| bool | isEmpty () const |
| bool | isFull () const |
| bool | isPopFrontDisabled () const |
| bool | isPushBackDisabled () const |
| bsl::size_t | numElements () const |
| int | waitUntilEmpty () const |
| bslma::Allocator * | allocator () const |
This class provides a thread-safe unbounded queue of values that assumes a single consumer thread.
See Component bdlcc_singleconsumerqueue
| typedef TYPE bdlcc::SingleConsumerQueue< TYPE >::value_type |
The type for elements.
| bdlcc::SingleConsumerQueue< TYPE >::SingleConsumerQueue | ( | bslma::Allocator * | basicAllocator = 0 |
) | [explicit] |
Create a thread-aware queue. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.
| bdlcc::SingleConsumerQueue< TYPE >::SingleConsumerQueue | ( | 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.
| bdlcc::SingleConsumerQueue< TYPE >::~SingleConsumerQueue | ( | ) |
Destroy this object.
| bdlcc::SingleConsumerQueue< TYPE >::BSLMF_NESTED_TRAIT_DECLARATION | ( | SingleConsumerQueue< TYPE > | , | |
| bslma::UsesBslmaAllocator | ||||
| ) |
| int bdlcc::SingleConsumerQueue< TYPE >::popFront | ( | TYPE * | value | ) |
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_DISABLED if isPopFrontDisabled(). 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.
| int bdlcc::SingleConsumerQueue< TYPE >::pushBack | ( | 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_DISABLED if isPushBackDisabled().
| int bdlcc::SingleConsumerQueue< TYPE >::pushBack | ( | 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_DISABLED if isPushBackDisabled(). On failure, value is not changed.
| void bdlcc::SingleConsumerQueue< 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.
| int bdlcc::SingleConsumerQueue< TYPE >::tryPopFront | ( | TYPE * | value | ) |
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_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.
| int bdlcc::SingleConsumerQueue< 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_DISABLED if isPushBackDisabled().
| int bdlcc::SingleConsumerQueue< 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_DISABLED if isPushBackDisabled(). On failure, value is not changed.
| void bdlcc::SingleConsumerQueue< TYPE >::disablePopFront | ( | ) |
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.
| void bdlcc::SingleConsumerQueue< TYPE >::disablePushBack | ( | ) |
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.
| void bdlcc::SingleConsumerQueue< TYPE >::enablePushBack | ( | ) |
Enable queuing. If the queue is not enqueue disabled, this call has no effect.
| void bdlcc::SingleConsumerQueue< TYPE >::enablePopFront | ( | ) |
Enable dequeueing. If the queue is not dequeue disabled, this call has no effect.
| bool bdlcc::SingleConsumerQueue< TYPE >::isEmpty | ( | ) | const |
Return true if this queue is empty (has no elements), or false otherwise.
| bool bdlcc::SingleConsumerQueue< TYPE >::isFull | ( | ) | const |
Return true if this queue is full (has no available capacity), or false otherwise. Note that for unbounded queues, this method always returns false.
| bool bdlcc::SingleConsumerQueue< TYPE >::isPopFrontDisabled | ( | ) | const |
Return true if this queue is dequeue disabled, and false otherwise. Note that the queue is created in the "dequeue enabled" state.
| bool bdlcc::SingleConsumerQueue< TYPE >::isPushBackDisabled | ( | ) | const |
Return true if this queue is enqueue disabled, and false otherwise. Note that the queue is created in the "enqueue enabled" state.
| bsl::size_t bdlcc::SingleConsumerQueue< TYPE >::numElements | ( | ) | const |
Returns the number of elements currently in this queue.
| int bdlcc::SingleConsumerQueue< 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_DISABLED if !isEmpty() && isPopFrontDisabled(). A blocked thread waiting for the queue to empty will return e_DISABLED if disablePopFront is invoked.
| bslma::Allocator* bdlcc::SingleConsumerQueue< TYPE >::allocator | ( | ) | const |
Return the allocator used by this object to supply memory.
1.7.1