Class PushPullConcurrentQueue<E>

java.lang.Object
com.conversantmedia.util.concurrent.PushPullConcurrentQueue<E>
All Implemented Interfaces:
ConcurrentQueue<E>
Direct Known Subclasses:
PushPullBlockingQueue
public class PushPullConcurrentQueue<E> extends Object implements ConcurrentQueue<E>
Tuned version of Martin Thompson's push pull queue Transfers from a single thread writer to a single thread reader are orders of nanoseconds (3-5) This code is optimized and tested using a 64bit HotSpot JVM on an Intel x86-64 environment. Other environments should be carefully tested before using in production. Created by jcairns on 5/28/14.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) long
    a1
     
    (package private) long
    a2
     
    (package private) long
    a3
     
    (package private) long
    a4
     
    (package private) long
    a5
     
    (package private) long
    a6
     
    (package private) long
    a7
     
    (package private) long
    a8
     
    (package private) final E[]
    buffer
     
    (package private) long
    c1
     
    (package private) long
    c2
     
    (package private) long
    c3
     
    (package private) long
    c4
     
    (package private) long
    c5
     
    (package private) long
    c6
     
    (package private) long
    c7
     
    (package private) long
    c8
     
    (package private) final LongAdder
    head
     
    (package private) long
    headCache
     
    (package private) final long
    mask
     
    (package private) long
    p1
     
    (package private) long
    p2
     
    (package private) long
    p3
     
    (package private) long
    p4
     
    (package private) long
    p5
     
    (package private) long
    p6
     
    (package private) long
    p7
     
    (package private) long
    r1
     
    (package private) long
    r2
     
    (package private) long
    r3
     
    (package private) long
    r4
     
    (package private) long
    r5
     
    (package private) long
    r6
     
    (package private) long
    r7
     
    (package private) final int
    size
     
    (package private) final LongAdder
    tail
     
    (package private) long
    tailCache
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    PushPullConcurrentQueue(int capacity)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    capacity()
     
    void
    clear()
    clear the queue of all elements
    final boolean
    contains(Object o)
     
    final boolean
    isEmpty()
     
    boolean
    offer(E e)
    Add element t to the ring
    final E
    peek()
    return the first element in the queue
    E
    poll()
    remove the first element from the queue and return it
    int
    remove(E[] e)
    return all elements in the queue to the provided array, up to the size of the provided array.
    final int
    size()
    This implemention is known to be broken if preemption were to occur after reading the tail pointer.
    (package private) long
    sumToAvoidOptimization()
     

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • size

      final int size

    • mask

      final long mask

    • tail

      final LongAdder tail

    • p1

      long p1

    • p2

      long p2

    • p3

      long p3

    • p4

      long p4

    • p5

      long p5

    • p6

      long p6

    • p7

      long p7

    • tailCache

      long tailCache

    • a1

      long a1

    • a2

      long a2

    • a3

      long a3

    • a4

      long a4

    • a5

      long a5

    • a6

      long a6

    • a7

      long a7

    • a8

      long a8

    • buffer

      final E[] buffer

    • r1

      long r1

    • r2

      long r2

    • r3

      long r3

    • r4

      long r4

    • r5

      long r5

    • r6

      long r6

    • r7

      long r7

    • headCache

      long headCache

    • c1

      long c1

    • c2

      long c2

    • c3

      long c3

    • c4

      long c4

    • c5

      long c5

    • c6

      long c6

    • c7

      long c7

    • c8

      long c8

  • Constructor Details

    • PushPullConcurrentQueue

      public PushPullConcurrentQueue(int capacity)

  • Method Details

    • offer

      public boolean offer(E e)
      Description copied from interface: ConcurrentQueue
      Add element t to the ring
      Specified by:
      offer in interface ConcurrentQueue<E>
      Parameters:
      e - - element to offer
      Returns:
      boolean - true if the operation succeeded

    • poll

      public E poll()
      Description copied from interface: ConcurrentQueue
      remove the first element from the queue and return it
      Specified by:
      poll in interface ConcurrentQueue<E>
      Returns:
      T

    • remove

      public int remove(E[] e)
      Description copied from interface: ConcurrentQueue
      return all elements in the queue to the provided array, up to the size of the provided array.
      Specified by:
      remove in interface ConcurrentQueue<E>
      Parameters:
      e - - The element array
      Returns:
      int - the number of elements added to t

    • clear

      public void clear()
      Description copied from interface: ConcurrentQueue
      clear the queue of all elements
      Specified by:
      clear in interface ConcurrentQueue<E>

    • peek

      public final E peek()
      Description copied from interface: ConcurrentQueue
      return the first element in the queue
      Specified by:
      peek in interface ConcurrentQueue<E>
      Returns:
      E - The element

    • size

      public final int size()
      This implemention is known to be broken if preemption were to occur after reading the tail pointer. Code should not depend on size for a correct result.
      Specified by:
      size in interface ConcurrentQueue<E>
      Returns:
      int - possibly the size, or possibly any value less than capacity()

    • capacity

      public int capacity()
      Specified by:
      capacity in interface ConcurrentQueue<E>
      Returns:
      int - the capacity of the queue

    • isEmpty

      public final boolean isEmpty()
      Specified by:
      isEmpty in interface ConcurrentQueue<E>
      Returns:
      boolean - true if the queue is currently empty

    • contains

      public final boolean contains(Object o)
      Specified by:
      contains in interface ConcurrentQueue<E>
      Parameters:
      o - - the object to test
      Returns:
      boolean - true if specified object is contained in the queue

    • sumToAvoidOptimization

      long sumToAvoidOptimization()