opendaylight/md-sal/sal-common-util/src/main/java/org/opendaylight/controller/md/sal/common/util/jmx/ThreadExecutorStatsMXBean.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.controller.md.sal.common.util.jmx;
  10
  11 /**
  12  * MXBean interface for thread executor statistic metrics.
  13  *
  14  * @author Thomas Pantelis
  15  */
  16 public interface ThreadExecutorStatsMXBean {
  17
  18     /**
  19      * Returns the current thread pool size.
  20      */
  21     long getCurrentThreadPoolSize();
  22
  23     /**
  24      * Returns the largest thread pool size.
  25      */
  26     long getLargestThreadPoolSize();
  27
  28     /**
  29      * Returns the maximum thread pool size.
  30      */
  31     long getMaxThreadPoolSize();
  32
  33     /**
  34      * Returns the current queue size.
  35      */
  36     long getCurrentQueueSize();
  37
  38     /**
  39      * Returns the largest queue size, if available.
  40      */
  41     Long getLargestQueueSize();
  42
  43     /**
  44      * Returns the maximum queue size.
  45      */
  46     long getMaxQueueSize();
  47
  48     /**
  49      * Returns the active thread count.
  50      */
  51     long getActiveThreadCount();
  52
  53     /**
  54      * Returns the completed task count.
  55      */
  56     long getCompletedTaskCount();
  57
  58     /**
  59      * Returns the total task count.
  60      */
  61     long getTotalTaskCount();
  62
  63     /**
  64      * Returns the rejected task count, if available.
  65      */
  66     Long getRejectedTaskCount();
  67 }