Class MPMCBlockingQueue<E>
- java.lang.Object
-
- com.conversantmedia.util.concurrent.MPMCBlockingQueue<E>
-
- All Implemented Interfaces:
ConcurrentQueue<E>,Serializable,Iterable<E>,Collection<E>,BlockingQueue<E>,Queue<E>
public final class MPMCBlockingQueue<E> extends Object implements Serializable, Iterable<E>, Collection<E>, BlockingQueue<E>, Queue<E>, ConcurrentQueue<E>
Alternative implementation for benchmarking purposes- Author:
- John Cairns <john@2ad.com> Date: 4/20/16
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected com.conversantmedia.util.concurrent.ConditionqueueNotEmptyConditionprotected com.conversantmedia.util.concurrent.ConditionqueueNotFullConditionprotected intsize
-
Constructor Summary
Constructors Constructor Description MPMCBlockingQueue(int capacity)Construct a blocking queue of the given fixed capacity.MPMCBlockingQueue(int capacity, SpinPolicy spinPolicy)Construct a blocking queue with a given fixed capacityMPMCBlockingQueue(int capacity, Collection<? extends E> c)Construct a blocking queue of the given fixed capacity
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanadd(E e)booleanaddAll(Collection<? extends E> c)intcapacity()voidclear()clear the queue of all elementsbooleancontains(Object o)booleancontainsAll(Collection<?> c)intdrainTo(Collection<? super E> c)intdrainTo(Collection<? super E> c, int maxElements)Eelement()booleanisEmpty()Iterator<E>iterator()booleanoffer(E e)Add element t to the ringbooleanoffer(E e, long timeout, TimeUnit unit)Epeek()return the first element in the queueEpoll()remove the first element from the queue and return itEpoll(long timeout, TimeUnit unit)voidput(E e)intremainingCapacity()Eremove()intremove(E[] e)return all elements in the queue to the provided array, up to the size of the provided array.booleanremove(Object o)booleanremoveAll(Collection<?> c)booleanretainAll(Collection<?> c)intsize()Etake()Object[]toArray()<T> T[]toArray(T[] a)-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.concurrent.BlockingQueue
contains
-
Methods inherited from interface java.util.Collection
equals, hashCode, isEmpty, parallelStream, removeIf, size, spliterator, stream, toArray
-
-
-
-
Constructor Detail
-
MPMCBlockingQueue
public MPMCBlockingQueue(int capacity)
Construct a blocking queue of the given fixed capacity.
Note: actual capacity will be the next power of two larger than capacity.- Parameters:
capacity- maximum capacity of this queue
-
MPMCBlockingQueue
public MPMCBlockingQueue(int capacity, SpinPolicy spinPolicy)Construct a blocking queue with a given fixed capacity
Note: actual capacity will be the next power of two larger than capacity. Waiting locking may be used in servers that are tuned for it, waiting locking provides a high performance locking implementation which is approximately a factor of 2 improvement in throughput (40M/s for 1-1 thread transfers) However waiting locking is more CPU aggressive and causes servers that may be configured with far too many threads to show very high load averages. This is probably not as detrimental as it is annoying.- Parameters:
capacity- - the queue capacity, suggest using a power of 2spinPolicy- - determine the level of cpu aggressiveness in waiting
-
MPMCBlockingQueue
public MPMCBlockingQueue(int capacity, Collection<? extends E> c)Construct a blocking queue of the given fixed capacity
Note: actual capacity will be the next power of two larger than capacity.
The values from the collection, c, are appended to the queue in iteration order. If the number of elements in the collection exceeds the actual capacity, then the additional elements overwrite the previous ones until all elements have been written once.- Parameters:
capacity- maximum capacity of this queuec- A collection to use to populate inital values
-
-
Method Detail
-
offer
public final boolean offer(E e)
Description copied from interface:ConcurrentQueueAdd element t to the ring- Specified by:
offerin interfaceBlockingQueue<E>- Specified by:
offerin interfaceConcurrentQueue<E>- Specified by:
offerin interfaceQueue<E>- Parameters:
e- - element to offer- Returns:
- boolean - true if the operation succeeded
-
poll
public final E poll()
Description copied from interface:ConcurrentQueueremove the first element from the queue and return it
-
remove
public int remove(E[] e)
Description copied from interface:ConcurrentQueuereturn all elements in the queue to the provided array, up to the size of the provided array.- Specified by:
removein interfaceConcurrentQueue<E>- Parameters:
e- - The element array- Returns:
- int - the number of elements added to t
-
put
public void put(E e) throws InterruptedException
- Specified by:
putin interfaceBlockingQueue<E>- Throws:
InterruptedException
-
offer
public boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException
- Specified by:
offerin interfaceBlockingQueue<E>- Throws:
InterruptedException
-
take
public E take() throws InterruptedException
- Specified by:
takein interfaceBlockingQueue<E>- Throws:
InterruptedException
-
poll
public E poll(long timeout, TimeUnit unit) throws InterruptedException
- Specified by:
pollin interfaceBlockingQueue<E>- Throws:
InterruptedException
-
clear
public void clear()
Description copied from interface:ConcurrentQueueclear the queue of all elements- Specified by:
clearin interfaceCollection<E>- Specified by:
clearin interfaceConcurrentQueue<E>
-
remainingCapacity
public int remainingCapacity()
- Specified by:
remainingCapacityin interfaceBlockingQueue<E>
-
drainTo
public int drainTo(Collection<? super E> c)
- Specified by:
drainToin interfaceBlockingQueue<E>
-
drainTo
public int drainTo(Collection<? super E> c, int maxElements)
- Specified by:
drainToin interfaceBlockingQueue<E>
-
toArray
public Object[] toArray()
- Specified by:
toArrayin interfaceCollection<E>
-
toArray
public <T> T[] toArray(T[] a)
- Specified by:
toArrayin interfaceCollection<E>
-
add
public boolean add(E e)
- Specified by:
addin interfaceBlockingQueue<E>- Specified by:
addin interfaceCollection<E>- Specified by:
addin interfaceQueue<E>
-
remove
public boolean remove(Object o)
- Specified by:
removein interfaceBlockingQueue<E>- Specified by:
removein interfaceCollection<E>
-
containsAll
public boolean containsAll(Collection<?> c)
- Specified by:
containsAllin interfaceCollection<E>
-
addAll
public boolean addAll(Collection<? extends E> c)
- Specified by:
addAllin interfaceCollection<E>
-
removeAll
public boolean removeAll(Collection<?> c)
- Specified by:
removeAllin interfaceCollection<E>
-
retainAll
public boolean retainAll(Collection<?> c)
- Specified by:
retainAllin interfaceCollection<E>
-
peek
public final E peek()
Description copied from interface:ConcurrentQueuereturn the first element in the queue- Specified by:
peekin interfaceConcurrentQueue<E>- Returns:
- E - The element
-
size
public final int size()
- Specified by:
sizein interfaceConcurrentQueue<E>- Returns:
- int - the number of elements in the queue
-
capacity
public int capacity()
- Specified by:
capacityin interfaceConcurrentQueue<E>- Returns:
- int - the capacity of the queue
-
isEmpty
public final boolean isEmpty()
- Specified by:
isEmptyin interfaceConcurrentQueue<E>- Returns:
- boolean - true if the queue is currently empty
-
contains
public final boolean contains(Object o)
- Specified by:
containsin interfaceConcurrentQueue<E>- Parameters:
o- - the object to test- Returns:
- boolean - true if specified object is contained in the queue
-
-