common/util/src/main/java/org/opendaylight/yangtools/util/concurrent/TrackingLinkedBlockingQueue.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.yangtools.util.concurrent;
  10
  11 import com.google.common.annotations.Beta;
  12 import java.util.Collection;
  13 import java.util.concurrent.LinkedBlockingQueue;
  14 import java.util.concurrent.TimeUnit;
  15 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  16
  17 /**
  18  * A {@link LinkedBlockingQueue} that tracks the largest queue size for debugging.
  19  *
  20  * @author Thomas Pantelis
  21  *
  22  * @param <E> the element t.ype
  23  */
  24 public class TrackingLinkedBlockingQueue<E> extends LinkedBlockingQueue<E> {
  25     private static final long serialVersionUID = 1L;
  26
  27     @SuppressWarnings("rawtypes")
  28     private static final AtomicIntegerFieldUpdater<TrackingLinkedBlockingQueue> LARGEST_QUEUE_SIZE_UPDATER
  29         = AtomicIntegerFieldUpdater.newUpdater(TrackingLinkedBlockingQueue.class, "largestQueueSize");
  30
  31     /**
  32      * Holds largestQueueSize, this long field should be only accessed
  33      * using {@link #LARGEST_QUEUE_SIZE_UPDATER}.
  34      */
  35     private volatile int largestQueueSize = 0;
  36
  37     /**
  38      * @see LinkedBlockingQueue#LinkedBlockingQueue
  39      */
  40     public TrackingLinkedBlockingQueue() {
  41         super();
  42     }
  43
  44     /**
  45      * @see LinkedBlockingQueue#LinkedBlockingQueue(Collection)
  46      */
  47     public TrackingLinkedBlockingQueue( final Collection<? extends E> c ) {
  48         super(c);
  49     }
  50
  51     /**
  52      * @see LinkedBlockingQueue#LinkedBlockingQueue(int)
  53      */
  54     public TrackingLinkedBlockingQueue( final int capacity ) {
  55         super(capacity);
  56     }
  57
  58     /**
  59      * Returns the largest queue size.
  60      *
  61      * <p>FIXME: the this return will be changed to int in a future release.
  62      */
  63     @Beta
  64     public long getLargestQueueSize() {
  65         return largestQueueSize;
  66     }
  67
  68     @Override
  69     public boolean offer(final E e, final long timeout, final TimeUnit unit) throws InterruptedException {
  70         if (super.offer( e, timeout, unit ) ) {
  71             updateLargestQueueSize();
  72             return true;
  73         }
  74
  75         return false;
  76     }
  77
  78     @Override
  79     public boolean offer(final E e) {
  80         if (super.offer( e ) ) {
  81             updateLargestQueueSize();
  82             return true;
  83         }
  84
  85         return false;
  86     }
  87
  88     @Override
  89     public void put( final E e ) throws InterruptedException {
  90         super.put( e );
  91         updateLargestQueueSize();
  92     }
  93
  94     @Override
  95     public boolean add(final E e) {
  96         boolean result = super.add( e );
  97         updateLargestQueueSize();
  98         return result;
  99     }
 100
 101     @Override
 102     public boolean addAll(final Collection<? extends E> c) {
 103         try {
 104             return super.addAll( c );
 105         } finally {
 106             updateLargestQueueSize();
 107         }
 108     }
 109
 110     private void updateLargestQueueSize() {
 111         final int size = size();
 112
 113         int largest;
 114         do {
 115             largest = largestQueueSize;
 116         } while (size > largest && !LARGEST_QUEUE_SIZE_UPDATER.weakCompareAndSet(this, largest, size));
 117     }
 118 }