[#BloombergLP-bdlcc-BoundedQueue]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlcc.adoc[bdlcc]::BoundedQueue
:relfileprefix: ../../
:mrdocs:

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

== Synopsis

Declared in `<bdlcc_boundedqueue.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
class BoundedQueue;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlcc/BoundedQueue/value_type.adoc[`value_type`] 
| The type for elements stored in this queue.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlcc/BoundedQueue/_04enum.adoc[`Unnamed enum`] 
| Status codes returned by queue operations.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlcc/BoundedQueue/2constructor.adoc[`BoundedQueue`]         [.small]#[constructor]#
| 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.
| xref:BloombergLP/bdlcc/BoundedQueue/2destructor.adoc[`~BoundedQueue`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdlcc/BoundedQueue/allocator.adoc[`allocator`] 
| Return the allocator used by this object to supply memory.
| xref:BloombergLP/bdlcc/BoundedQueue/capacity.adoc[`capacity`] 
| 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.
| xref:BloombergLP/bdlcc/BoundedQueue/disablePopFront.adoc[`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.
| xref:BloombergLP/bdlcc/BoundedQueue/disablePushBack.adoc[`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.
| xref:BloombergLP/bdlcc/BoundedQueue/enablePopFront.adoc[`enablePopFront`] 
| Enable dequeueing. If the queue is not dequeue disabled, this call has no effect.
| xref:BloombergLP/bdlcc/BoundedQueue/enablePushBack.adoc[`enablePushBack`] 
| Enable queuing. If the queue is not enqueue disabled, this call has no effect.
| xref:BloombergLP/bdlcc/BoundedQueue/isEmpty.adoc[`isEmpty`] 
| Return `true` if this queue is empty (has no elements), or `false` otherwise.
| xref:BloombergLP/bdlcc/BoundedQueue/isFull.adoc[`isFull`] 
| Return `true` if this queue is full (has no available capacity), or `false` otherwise. Note that for unbounded queues, this method always returns `false`.
| xref:BloombergLP/bdlcc/BoundedQueue/isPopFrontDisabled.adoc[`isPopFrontDisabled`] 
| Return `true` if this queue is dequeue disabled, and `false` otherwise. Note that the queue is created in the "dequeue enabled" state.
| xref:BloombergLP/bdlcc/BoundedQueue/isPushBackDisabled.adoc[`isPushBackDisabled`] 
| Return `true` if this queue is enqueue disabled, and `false` otherwise. Note that the queue is created in the "enqueue enabled" state.
| xref:BloombergLP/bdlcc/BoundedQueue/numElements.adoc[`numElements`] 
| 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).
| xref:BloombergLP/bdlcc/BoundedQueue/popFront.adoc[`popFront`] 
| 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.
| xref:BloombergLP/bdlcc/BoundedQueue/pushBack-0c.adoc[`pushBack`] 
| `pushBack` overloads
| xref:BloombergLP/bdlcc/BoundedQueue/removeAll.adoc[`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.
| xref:BloombergLP/bdlcc/BoundedQueue/tryPopFront.adoc[`tryPopFront`] 
| 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.
| xref:BloombergLP/bdlcc/BoundedQueue/tryPushBack-06.adoc[`tryPushBack`] 
| `tryPushBack` overloads
| xref:BloombergLP/bdlcc/BoundedQueue/waitUntilEmpty.adoc[`waitUntilEmpty`] 
| 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.
| xref:BloombergLP/bdlcc/BoundedQueue/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<BoundedQueue, UsesBslmaAllocator>`] 
| Declare that this type uses a `bslma` allocator.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlcc/BoundedQueue_PushExceptionCompleteProctor.adoc[BloombergLP::bdlcc::BoundedQueue_PushExceptionCompleteProctor]`
| This class implements a proctor that invokes `TYPE::pushExceptionComplete` upon destruction unless `release` has been called.
| `xref:BloombergLP/bdlcc/BoundedQueue_PopCompleteGuard.adoc[BloombergLP::bdlcc::BoundedQueue_PopCompleteGuard]`
| This class implements a guard that invokes `TYPE::popComplete` on a `NODE` upon destruction.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#