java.util.AbstractCollection<E>
java.util.AbstractQueue<E>
org.glassfish.grizzly.utils.LinkedTransferQueue<E>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
E - the type of elements held in this collectionpublic class LinkedTransferQueue<E>
An unbounded TransferQueue based on linked nodes. This queue orders elements FIFO (first-in-first-out) with respect to any given producer. The head of the queue is that element that has been on the queue the longest time for some producer. The tail of the queue is that element that has been on the queue the shortest time for some producer.
Beware that, unlike in most collections, the size
method is NOT a constant-time operation. Because of the
asynchronous nature of these queues, determining the current number
of elements requires a traversal of the elements.
This class and its iterator implement all of the
optional methods of the Collection and Iterator interfaces.
Memory consistency effects: As with other concurrent
collections, actions in a thread prior to placing an object into a
LinkedTransferQueue
happen-before
actions subsequent to the access or removal of that element from
the LinkedTransferQueue in another thread.
This class is a member of the
Java Collections Framework.
version 1.17 Tue Mar 31 15:17:19 2009 UTC ( gustav trede copied from jsr166 CVS )
| Constructor Summary | |
|---|---|
LinkedTransferQueue()
Creates an initially empty LinkedTransferQueue. |
|
LinkedTransferQueue(java.util.Collection<? extends E> c)
Creates a LinkedTransferQueue
initially containing the elements of the given collection,
added in traversal order of the collection's iterator. |
|
| Method Summary | |
|---|---|
boolean |
add(E e)
|
int |
drainTo(java.util.Collection<? super E> c)
|
int |
drainTo(java.util.Collection<? super E> c,
int maxElements)
|
int |
getWaitingConsumerCount()
Returns an estimate of the number of consumers waiting to dequeue elements via take or poll. |
boolean |
hasWaitingConsumer()
Returns true if there is at least one consumer waiting
to dequeue an element via take or poll. |
boolean |
isEmpty()
|
java.util.Iterator<E> |
iterator()
|
boolean |
offer(E e)
|
boolean |
offer(E e,
long timeout,
java.util.concurrent.TimeUnit unit)
|
E |
peek()
|
E |
poll()
|
E |
poll(long timeout,
java.util.concurrent.TimeUnit unit)
|
void |
put(E e)
|
int |
remainingCapacity()
|
boolean |
remove(java.lang.Object o)
|
int |
size()
Returns the number of elements in this queue. |
E |
take()
|
void |
transfer(E e)
Inserts the specified element into this queue, waiting if necessary for space to become available and the element to be dequeued by a consumer invoking take or poll. |
boolean |
tryTransfer(E e)
Transfers the specified element if there exists a consumer already waiting to receive it, otherwise returning false
without enqueuing the element. |
boolean |
tryTransfer(E e,
long timeout,
java.util.concurrent.TimeUnit unit)
Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available and the element to be dequeued by a consumer invoking take or poll. |
| Methods inherited from class java.util.AbstractQueue |
|---|
addAll, clear, element, remove |
| Methods inherited from class java.util.AbstractCollection |
|---|
contains, containsAll, removeAll, retainAll, toArray, toArray, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.util.concurrent.BlockingQueue |
|---|
contains |
| Methods inherited from interface java.util.Queue |
|---|
element, remove |
| Methods inherited from interface java.util.Collection |
|---|
addAll, clear, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray |
| Constructor Detail |
|---|
public LinkedTransferQueue()
LinkedTransferQueue.
public LinkedTransferQueue(java.util.Collection<? extends E> c)
LinkedTransferQueue
initially containing the elements of the given collection,
added in traversal order of the collection's iterator.
c - the collection of elements to initially contain
java.lang.NullPointerException - if the specified collection or any
of its elements are null| Method Detail |
|---|
public void put(E e)
throws java.lang.InterruptedException
put in interface java.util.concurrent.BlockingQueue<E>java.lang.InterruptedException
public boolean offer(E e,
long timeout,
java.util.concurrent.TimeUnit unit)
throws java.lang.InterruptedException
offer in interface java.util.concurrent.BlockingQueue<E>java.lang.InterruptedExceptionpublic boolean offer(E e)
offer in interface java.util.concurrent.BlockingQueue<E>offer in interface java.util.Queue<E>public boolean add(E e)
add in interface java.util.Collection<E>add in interface java.util.concurrent.BlockingQueue<E>add in interface java.util.Queue<E>add in class java.util.AbstractQueue<E>
public void transfer(E e)
throws java.lang.InterruptedException
TransferQueuetake or poll.
transfer in interface TransferQueue<E>e - the element to transfer
java.lang.InterruptedException - if interrupted while waiting,
in which case the element is not enqueued.
public boolean tryTransfer(E e,
long timeout,
java.util.concurrent.TimeUnit unit)
throws java.lang.InterruptedException
TransferQueuetake or poll.
tryTransfer in interface TransferQueue<E>e - the element to transfertimeout - how long to wait before giving up, in units of
unitunit - a TimeUnit determining how to interpret the
timeout parameter
true if successful, or false if
the specified waiting time elapses before completion,
in which case the element is not enqueued.
java.lang.InterruptedException - if interrupted while waiting,
in which case the element is not enqueued.public boolean tryTransfer(E e)
TransferQueuefalse
without enqueuing the element.
tryTransfer in interface TransferQueue<E>e - the element to transfer
true if the element was transferred, else
false
public E take()
throws java.lang.InterruptedException
take in interface java.util.concurrent.BlockingQueue<E>java.lang.InterruptedException
public E poll(long timeout,
java.util.concurrent.TimeUnit unit)
throws java.lang.InterruptedException
poll in interface java.util.concurrent.BlockingQueue<E>java.lang.InterruptedExceptionpublic E poll()
poll in interface java.util.Queue<E>public int drainTo(java.util.Collection<? super E> c)
drainTo in interface java.util.concurrent.BlockingQueue<E>
public int drainTo(java.util.Collection<? super E> c,
int maxElements)
drainTo in interface java.util.concurrent.BlockingQueue<E>public java.util.Iterator<E> iterator()
iterator in interface java.lang.Iterable<E>iterator in interface java.util.Collection<E>iterator in class java.util.AbstractCollection<E>public E peek()
peek in interface java.util.Queue<E>public boolean isEmpty()
isEmpty in interface java.util.Collection<E>isEmpty in class java.util.AbstractCollection<E>public boolean hasWaitingConsumer()
TransferQueuetrue if there is at least one consumer waiting
to dequeue an element via take or poll.
The return value represents a momentary state of affairs.
hasWaitingConsumer in interface TransferQueue<E>true if there is at least one waiting consumerpublic int size()
Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.
Beware that, unlike in most collections, this method is NOT a constant-time operation. Because of the asynchronous nature of these queues, determining the current number of elements requires an O(n) traversal.
size in interface java.util.Collection<E>size in class java.util.AbstractCollection<E>public int getWaitingConsumerCount()
TransferQueuetake or poll. The return
value is an approximation of a momentary state of affairs, that
may be inaccurate if consumers have completed or given up
waiting. The value may be useful for monitoring and heuristics,
but not for synchronization control. Implementations of this
method are likely to be noticeably slower than those for
TransferQueue.hasWaitingConsumer().
getWaitingConsumerCount in interface TransferQueue<E>public int remainingCapacity()
remainingCapacity in interface java.util.concurrent.BlockingQueue<E>public boolean remove(java.lang.Object o)
remove in interface java.util.Collection<E>remove in interface java.util.concurrent.BlockingQueue<E>remove in class java.util.AbstractCollection<E>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||