|
activemq-cpp-3.9.5
|
A BlockingQueue derivative that allows for a bound to be placed on the number of elements that can be enqueued at any one time. More...
#include <src/main/decaf/util/concurrent/LinkedBlockingQueue.h>

Public Member Functions | |||||||||||
| LinkedBlockingQueue () | |||||||||||
| Create a new instance with a Capacity of Integer::MAX_VALUE. | |||||||||||
| LinkedBlockingQueue (int capacity) | |||||||||||
| Create a new instance with the given initial capacity value. | |||||||||||
| LinkedBlockingQueue (const Collection< E > &collection) | |||||||||||
| Create a new instance with a Capacity of Integer::MAX_VALUE and adds all the values contained in the specified collection to this Queue. | |||||||||||
| LinkedBlockingQueue (const LinkedBlockingQueue &queue) | |||||||||||
| Create a new instance with a Capacity of Integer::MAX_VALUE and adds all the values contained in the specified LinkedBlockingQueue to this Queue. | |||||||||||
| virtual | ~LinkedBlockingQueue () | ||||||||||
| LinkedBlockingQueue< E > & | operator= (const LinkedBlockingQueue< E > &queue) | ||||||||||
| LinkedBlockingQueue< E > & | operator= (const Collection< E > &collection) | ||||||||||
| virtual int | size () const | ||||||||||
| Returns the number of elements in this collection. | |||||||||||
| virtual void | clear () | ||||||||||
Removes all of the elements from this collection (optional operation).This collection will be empty after this method returns unless it throws an exception.
| |||||||||||
| virtual int | remainingCapacity () const | ||||||||||
Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking, or Integer::MAX_VALUE if there is no intrinsic limit. | |||||||||||
| virtual void | put (const E &value) | ||||||||||
| Inserts the specified element into this queue, waiting if necessary for space to become available. | |||||||||||
| virtual bool | offer (const E &value, long long timeout, const TimeUnit &unit) | ||||||||||
| Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available. | |||||||||||
| virtual bool | offer (const E &value) | ||||||||||
| Inserts the specified element into the queue provided that the condition allows such an operation. | |||||||||||
| virtual E | take () | ||||||||||
| Retrieves and removes the head of this queue, waiting if necessary until an element becomes available. | |||||||||||
| virtual bool | poll (E &result, long long timeout, const TimeUnit &unit) | ||||||||||
| Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available. | |||||||||||
| virtual bool | poll (E &result) | ||||||||||
| Gets and removes the element in the head of the queue. | |||||||||||
| virtual bool | peek (E &result) const | ||||||||||
| Gets but not removes the element in the head of the queue. | |||||||||||
| virtual bool | remove (const E &value) | ||||||||||
| Removes a single instance of the specified element from the collection. | |||||||||||
| virtual std::vector< E > | toArray () const | ||||||||||
| Returns an array containing all of the elements in this collection. | |||||||||||
| virtual std::string | toString () const | ||||||||||
| virtual int | drainTo (Collection< E > &c) | ||||||||||
| Removes all available elements from this queue and adds them to the given collection. | |||||||||||
| virtual int | drainTo (Collection< E > &sink, int maxElements) | ||||||||||
| Removes at most the given number of available elements from this queue and adds them to the given collection. | |||||||||||
| virtual decaf::util::Iterator< E > * | iterator () | ||||||||||
| virtual decaf::util::Iterator< E > * | iterator () const | ||||||||||
Public Member Functions inherited from decaf::util::concurrent::BlockingQueue< E > | |||||||||||
| virtual | ~BlockingQueue () | ||||||||||
Public Member Functions inherited from decaf::util::AbstractQueue< E > | |||||||||||
| AbstractQueue () | |||||||||||
| virtual | ~AbstractQueue () | ||||||||||
| virtual bool | add (const E &value) | ||||||||||
Returns true if this collection changed as a result of the call.(Returns false if this collection does not permit duplicates and already contains the specified element.)Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.For non-pointer values, i.e. class instances or string's the object will be copied into the collection, thus the object must support being copied, must not hide the copy constructor and assignment operator.
| |||||||||||
| virtual bool | addAll (const Collection< E > &collection) | ||||||||||
Adds all of the elements in the specified collection to this collection.The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)
| |||||||||||
| virtual E | remove () | ||||||||||
Gets and removes the element in the head of the queue.Throws a NoSuchElementException if there is no element in the queue.
| |||||||||||
| virtual E | element () const | ||||||||||
Gets but not removes the element in the head of the queue.Throws a NoSuchElementException if there is no element in the queue.
| |||||||||||
Public Member Functions inherited from decaf::util::Queue< E > | |||||||||||
| virtual | ~Queue () | ||||||||||
Public Member Functions inherited from decaf::util::Collection< E > | |||||||||||
| virtual | ~Collection () | ||||||||||
Public Member Functions inherited from decaf::lang::Iterable< E > | |||||||||||
| virtual | ~Iterable () | ||||||||||
Public Member Functions inherited from decaf::util::concurrent::Synchronizable | |||||||||||
| virtual | ~Synchronizable () | ||||||||||
Public Member Functions inherited from decaf::util::AbstractCollection< E > | |||||||||||
| AbstractCollection () | |||||||||||
| AbstractCollection (const AbstractCollection &other) | |||||||||||
| Copy Constructor, copy element from the source collection to this collection after clearing any element stored in this collection. | |||||||||||
| virtual | ~AbstractCollection () | ||||||||||
| AbstractCollection< E > & | operator= (const AbstractCollection< E > &collection) | ||||||||||
| Assignment Operator, copy element from the source collection to this collection after clearing any element stored in this collection. | |||||||||||
| virtual bool | contains (const E &value) const | ||||||||||
Returns true if this collection contains the specified element.More formally, returns true if and only if this collection contains at least one element e such that (value == NULL ? e == NULL : value == e ).
| |||||||||||
| virtual bool | containsAll (const Collection< E > &collection) const | ||||||||||
Returns true if this collection contains all of the elements in the specified collection.
| |||||||||||
| virtual bool | equals (const Collection< E > &collection) const | ||||||||||
| Answers true if this Collection and the one given are the same size and if each element contained in the Collection given is equal to an element contained in this collection. | |||||||||||
| virtual void | copy (const Collection< E > &collection) | ||||||||||
| Renders this Collection as a Copy of the given Collection. | |||||||||||
| virtual bool | isEmpty () const | ||||||||||
| Returns true if this collection contains no elements. | |||||||||||
| virtual bool | add (const E &value DECAF_UNUSED) | ||||||||||
| virtual bool | removeAll (const Collection< E > &collection) | ||||||||||
Removes all this collection's elements that are also contained in the specified collection (optional operation).After this call returns, this collection will contain no elements in common with the specified collection.
| |||||||||||
| virtual bool | retainAll (const Collection< E > &collection) | ||||||||||
Retains only the elements in this collection that are contained in the specified collection (optional operation).In other words, removes from this collection all of its elements that are not contained in the specified collection.
| |||||||||||
| virtual void | lock () | ||||||||||
| Locks the object. | |||||||||||
| virtual bool | tryLock () | ||||||||||
| Attempts to Lock the object, if the lock is already held by another thread than this method returns false. | |||||||||||
| virtual void | unlock () | ||||||||||
| Unlocks the object. | |||||||||||
| virtual void | wait () | ||||||||||
| Waits on a signal from this object, which is generated by a call to Notify. | |||||||||||
| virtual void | wait (long long millisecs) | ||||||||||
| Waits on a signal from this object, which is generated by a call to Notify. | |||||||||||
| virtual void | wait (long long millisecs, int nanos) | ||||||||||
| Waits on a signal from this object, which is generated by a call to Notify. | |||||||||||
| virtual void | notify () | ||||||||||
| Signals a waiter on this object that it can now wake up and continue. | |||||||||||
| virtual void | notifyAll () | ||||||||||
| Signals the waiters on this object that it can now wake up and continue. | |||||||||||
Additional Inherited Members | |
Protected Attributes inherited from decaf::util::AbstractCollection< E > | |
| util::concurrent::Mutex | mutex |
A BlockingQueue derivative that allows for a bound to be placed on the number of elements that can be enqueued at any one time.
Elements are inserted and removed in FIFO order. The internal structure of the queue is based on a linked nodes which provides for better performance over their array based versions but the performance is less predictable.
The capacity bound of this class default to Integer::MAX_VALUE.
|
inline |
Create a new instance with a Capacity of Integer::MAX_VALUE.
References decaf::util::concurrent::locks::ReentrantLock::newCondition(), and decaf::lang::Pointer< T, REFCOUNTER >::reset().
|
inline |
Create a new instance with the given initial capacity value.
| capacity | The initial capacity value to assign to this Queue. |
| IllegalArgumentException | if the specified capacity is not greater than zero. |
References decaf::util::concurrent::locks::ReentrantLock::newCondition(), and decaf::lang::Pointer< T, REFCOUNTER >::reset().
|
inline |
Create a new instance with a Capacity of Integer::MAX_VALUE and adds all the values contained in the specified collection to this Queue.
| collection | The Collection whose elements are to be copied to this Queue. |
| IllegalStateException | if the number of elements in the collection exceeds this Queue's capacity. |
References DECAF_CATCH_RETHROW, DECAF_CATCHALL_THROW, decaf::lang::Iterable< E >::iterator(), decaf::util::concurrent::locks::ReentrantLock::newCondition(), and decaf::lang::Pointer< T, REFCOUNTER >::reset().
|
inline |
Create a new instance with a Capacity of Integer::MAX_VALUE and adds all the values contained in the specified LinkedBlockingQueue to this Queue.
| queue | The LinkedBlockingQueue whose elements are to be copied to this Queue. |
| IllegalStateException | if the number of elements in the collection exceeds this Queue's capacity. |
References DECAF_CATCH_RETHROW, DECAF_CATCHALL_THROW, decaf::util::concurrent::LinkedBlockingQueue< E >::iterator(), decaf::util::concurrent::locks::ReentrantLock::newCondition(), and decaf::lang::Pointer< T, REFCOUNTER >::reset().
|
inlinevirtual |
|
inlinevirtual |
Removes all of the elements from this collection (optional operation).This collection will be empty after this method returns unless it throws an exception.
| UnsupportedOperationExceptio | if this is an unmodifiable collection. |
This implementation repeatedly invokes poll until it returns false.
Reimplemented from decaf::util::AbstractQueue< E >.
References decaf::util::concurrent::atomic::AtomicInteger::getAndSet(), decaf::util::AbstractCollection< E >::lock(), and decaf::util::concurrent::atomic::AtomicInteger::set().
Referenced by decaf::util::concurrent::LinkedBlockingQueue< E >::operator=(), and decaf::util::concurrent::LinkedBlockingQueue< E >::operator=().
|
inlinevirtual |
Removes all available elements from this queue and adds them to the given collection.
This operation may be more efficient than repeatedly polling this queue. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
| c | the collection to transfer elements into |
| UnsupportedOperationException | if addition of elements is not supported by the specified collection |
| IllegalArgumentException | if the specified collection is this queue, or some property of an element of this queue prevents it from being added to the specified collection |
Implements decaf::util::concurrent::BlockingQueue< E >.
References decaf::util::concurrent::LinkedBlockingQueue< E >::drainTo(), and decaf::lang::Integer::MAX_VALUE.
Referenced by decaf::util::concurrent::LinkedBlockingQueue< E >::drainTo().
|
inlinevirtual |
Removes at most the given number of available elements from this queue and adds them to the given collection.
A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
| c | the collection to transfer elements into |
| maxElements | the maximum number of elements to transfer |
| UnsupportedOperationException | if addition of elements is not supported by the specified collection |
| IllegalArgumentException | if the specified collection is this queue, or some property of an element of this queue prevents it from being added to the specified collection |
Implements decaf::util::concurrent::BlockingQueue< E >.
References decaf::util::Collection< E >::add(), decaf::util::concurrent::atomic::AtomicInteger::get(), decaf::util::concurrent::atomic::AtomicInteger::getAndAdd(), decaf::util::concurrent::locks::ReentrantLock::lock(), decaf::lang::Math::min(), and decaf::util::concurrent::locks::ReentrantLock::unlock().
|
inlinevirtual |
Implements decaf::lang::Iterable< E >.
Referenced by decaf::util::concurrent::LinkedBlockingQueue< E >::LinkedBlockingQueue().
|
inlinevirtual |
Implements decaf::lang::Iterable< E >.
|
inlinevirtual |
Inserts the specified element into the queue provided that the condition allows such an operation.
The method is generally preferable to the collection.add(E), since the latter might throw an exception if the operation fails.
| value | the specified element to insert into the queue. |
| NullPointerException | if the Queue implementation does not allow Null values to be inserted into the Queue. |
| IllegalArgumentException | if some property of the specified element prevents it from being added to this queue |
Implements decaf::util::Queue< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get(), decaf::util::concurrent::atomic::AtomicInteger::getAndIncrement(), decaf::util::concurrent::locks::ReentrantLock::lockInterruptibly(), and decaf::util::concurrent::locks::ReentrantLock::unlock().
|
inlinevirtual |
Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.
| e | the element to add |
| timeout | how long to wait before giving up, in units of unit |
| unit | a TimeUnit determining how to interpret the timeout parameter |
true if successful, or false if the specified waiting time elapses before space is available| InterruptedException | if interrupted while waiting |
| NullPointerException | if the specified element is null |
| IllegalArgumentException | if some property of the specified element prevents it from being added to this queue |
Implements decaf::util::concurrent::BlockingQueue< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get(), decaf::util::concurrent::atomic::AtomicInteger::getAndIncrement(), decaf::util::concurrent::locks::ReentrantLock::lockInterruptibly(), decaf::util::concurrent::TimeUnit::toNanos(), and decaf::util::concurrent::locks::ReentrantLock::unlock().
|
inline |
|
inline |
|
inlinevirtual |
Gets but not removes the element in the head of the queue.
The result if successful is assigned to the result parameter.
| result | Reference to an instance of the contained type to assigned the removed value to. |
Implements decaf::util::Queue< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get(), decaf::util::concurrent::locks::ReentrantLock::lock(), NULL, and decaf::util::concurrent::locks::ReentrantLock::unlock().
|
inlinevirtual |
Gets and removes the element in the head of the queue.
If the operation succeeds the value of the element at the head of the Queue is assigned to the result parameter and the method returns true. If the operation fails the method returns false and the value of the result parameter is undefined.
| result | Reference to an instance of the contained type to assigned the removed value to. |
Implements decaf::util::Queue< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get(), decaf::util::concurrent::atomic::AtomicInteger::getAndDecrement(), decaf::util::concurrent::locks::ReentrantLock::lock(), and decaf::util::concurrent::locks::ReentrantLock::unlock().
|
inlinevirtual |
Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.
| result | the referenced value that will be assigned the value retrieved from the Queue. Undefined if this methods returned false. |
| timeout | how long to wait before giving up, in units of unit |
| unit | a TimeUnit determining how to interpret the timeout parameter. |
true if successful or false if the specified waiting time elapses before an element is available. | InterruptedException | if interrupted while waiting |
Implements decaf::util::concurrent::BlockingQueue< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get(), decaf::util::concurrent::atomic::AtomicInteger::getAndDecrement(), decaf::util::concurrent::locks::ReentrantLock::lockInterruptibly(), decaf::util::concurrent::TimeUnit::toNanos(), and decaf::util::concurrent::locks::ReentrantLock::unlock().
|
inlinevirtual |
Inserts the specified element into this queue, waiting if necessary for space to become available.
| value | the element to add |
| InterruptedException | if interrupted while waiting |
| NullPointerException | if the specified element is null |
| IllegalArgumentException | if some property of the specified element prevents it from being added to this queue |
Implements decaf::util::concurrent::BlockingQueue< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get(), decaf::util::concurrent::atomic::AtomicInteger::getAndIncrement(), decaf::util::concurrent::locks::ReentrantLock::lockInterruptibly(), and decaf::util::concurrent::locks::ReentrantLock::unlock().
|
inlinevirtual |
Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking, or Integer::MAX_VALUE if there is no intrinsic limit.
Note that you cannot always tell if an attempt to insert an element will succeed by inspecting remainingCapacity because it may be the case that another thread is about to insert or remove an element.
Implements decaf::util::concurrent::BlockingQueue< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get().
|
inlinevirtual |
Removes a single instance of the specified element from the collection.
More formally, removes an element e such that (value == NULL ? e == NULL : value == e), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).
| value | The reference to the element to remove from this Collection. |
| UnsupportedOperationExceptio | if this is an unmodifiable collection. |
| NullPointerException | if the Collection is a container of pointers and does not allow NULL values. |
Implements decaf::util::Collection< E >.
References decaf::util::AbstractCollection< E >::lock(), and NULL.
|
inlinevirtual |
Returns the number of elements in this collection.
If this collection contains more than Integer::MAX_VALUE elements, returns Integer::MAX_VALUE.
Implements decaf::util::Collection< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get().
Referenced by decaf::util::concurrent::LinkedBlockingQueue< E >::toArray().
|
inlinevirtual |
Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.
| InterruptedException | if interrupted while waiting |
Implements decaf::util::concurrent::BlockingQueue< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get(), decaf::util::concurrent::atomic::AtomicInteger::getAndDecrement(), decaf::util::concurrent::locks::ReentrantLock::lockInterruptibly(), and decaf::util::concurrent::locks::ReentrantLock::unlock().
|
inlinevirtual |
Returns an array containing all of the elements in this collection.
If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
This method acts as bridge between array-based and collection-based APIs.
Implements decaf::util::Collection< E >.
References decaf::util::concurrent::atomic::AtomicInteger::get(), decaf::util::AbstractCollection< E >::lock(), NULL, and decaf::util::concurrent::LinkedBlockingQueue< E >::size().
|
inlinevirtual |