org.jdiameter.api.Statistic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdiameter-api Show documentation

There is a newer version: 1.7.1-123

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2006, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jdiameter.api;

/**
 * This class is container for statistics information.
 * For example: Count Request/Answer messages
 * 
 * @author [email protected]
 * @version 1.5.1 Final
 */
public interface Statistic {

  /**
   * Return name of statistic
   * @return  name of statistic
   */
  String getName();

  /**
   * Return description of statistic
   * @return description of statistic
   */
  String getDescription();

  /**
   * Enable/Disable collecting statistics
   * @param value true for enable statistic
   */
  void enable(boolean value);

  /**
   * Return true is statistic is collecting
   * @return  true is statistic is collecting
   */
  boolean isEnabled();

  /**
   * Reset all counter in statistic
   */
  void reset();

  /**
   * Return counters of statistics
   * @return counters of statistics
   */
  StatisticRecord[] getRecords();
}