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 import javax.annotation.Nonnull;
  17
  18 /**
  19  * A {@link LinkedBlockingQueue} that tracks the largest queue size for debugging.
  20  *
  21  * @author Thomas Pantelis
  22  *
  23  * @param <E> the element t.ype
  24  */
  25 public class TrackingLinkedBlockingQueue<E> extends LinkedBlockingQueue<E> {
  26     private static final long serialVersionUID = 1L;
  27
  28     @SuppressWarnings("rawtypes")
  29     private static final AtomicIntegerFieldUpdater<TrackingLinkedBlockingQueue> LARGEST_QUEUE_SIZE_UPDATER
  30         = AtomicIntegerFieldUpdater.newUpdater(TrackingLinkedBlockingQueue.class, "largestQueueSize");
  31
  32     /**
  33      * Holds largestQueueSize, this long field should be only accessed
  34      * using {@link #LARGEST_QUEUE_SIZE_UPDATER}.
  35      */
  36     private volatile int largestQueueSize = 0;
  37
  38     /**
  39      * See {@link LinkedBlockingQueue#LinkedBlockingQueue()}.
  40      */
  41     public TrackingLinkedBlockingQueue() {
  42         super();
  43     }
  44
  45     /**
  46      * See {@link LinkedBlockingQueue#LinkedBlockingQueue(Collection)}.
  47      */
  48     @SuppressWarnings("checkstyle:parameterName")
  49     public TrackingLinkedBlockingQueue(final Collection<? extends E> c) {
  50         super(c);
  51     }
  52
  53     /**
  54      * See {@link LinkedBlockingQueue#LinkedBlockingQueue(int)}.
  55      */
  56     public TrackingLinkedBlockingQueue(final int capacity) {
  57         super(capacity);
  58     }
  59
  60     /**
  61      * Returns the largest queue size.
  62      *
  63      * <p>FIXME: the this return will be changed to int in a future release.
  64      */
  65     @Beta
  66     public long getLargestQueueSize() {
  67         return largestQueueSize;
  68     }
  69
  70     @Override
  71     @SuppressWarnings("checkstyle:parameterName")
  72     public boolean offer(final E e, final long timeout, final TimeUnit unit) throws InterruptedException {
  73         if (super.offer(e, timeout, unit)) {
  74             updateLargestQueueSize();
  75             return true;
  76         }
  77
  78         return false;
  79     }
  80
  81     @Override
  82     @SuppressWarnings("checkstyle:parameterName")
  83     public boolean offer(@Nonnull final E e) {
  84         if (super.offer(e)) {
  85             updateLargestQueueSize();
  86             return true;
  87         }
  88
  89         return false;
  90     }
  91
  92     @Override
  93     @SuppressWarnings("checkstyle:parameterName")
  94     public void put(final E e) throws InterruptedException {
  95         super.put(e);
  96         updateLargestQueueSize();
  97     }
  98
  99     @Override
 100     @SuppressWarnings("checkstyle:parameterName")
 101     public boolean add(final E e) {
 102         boolean result = super.add(e);
 103         updateLargestQueueSize();
 104         return result;
 105     }
 106
 107     @Override
 108     @SuppressWarnings("checkstyle:parameterName")
 109     public boolean addAll(final Collection<? extends E> c) {
 110         try {
 111             return super.addAll(c);
 112         } finally {
 113             updateLargestQueueSize();
 114         }
 115     }
 116
 117     private void updateLargestQueueSize() {
 118         final int size = size();
 119
 120         int largest;
 121         do {
 122             largest = largestQueueSize;
 123         } while (size > largest && !LARGEST_QUEUE_SIZE_UPDATER.weakCompareAndSet(this, largest, size));
 124     }
 125 }