This class provides a thread‐safe unbounded queue of values that assumes a single producer thread.

Synopsis

Declared in <bdlcc_singleproducerqueue.h>

template<class TYPE>
class SingleProducerQueue;

Type Aliases

Name

Description

value_type

The type for elements stored in this queue.

Enums

Name

Description

Unnamed enum

Status codes returned by queue operations.

Member Functions

Name

Description

SingleProducerQueue [constructor]

Constructors

allocator

Return the allocator used by this object to supply memory.

disablePopFront

Disable dequeueing from this queue.

disablePushBack

Disable enqueueing into this queue.

enablePopFront

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

enablePushBack

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

isEmpty

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

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.

isPopFrontDisabled

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

isPushBackDisabled

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

numElements

Returns the number of elements currently in this queue.

popFront

Remove the front element and load it into the specified value.

pushBack

pushBack overloads

removeAll

Remove all items currently in this queue.

tryPopFront

Attempt to remove the front element without blocking.

tryPushBack

tryPushBack overloads

waitUntilEmpty

Block until all elements in this queue are removed.

operator BloombergLP::bslmf::NestedTraitDeclaration<SingleProducerQueue, UsesBslmaAllocator>

Declare that this type uses a bslma allocator.

Created with MrDocs