net.sf.ehcache.util.ratestatistics.RateStatistic Maven / Gradle / Ivy

Go to download
/**
 *  Copyright Terracotta, Inc.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package net.sf.ehcache.util.ratestatistics;

/**
 * Rate monitoring statistic.
 *
 * @author Chris Dennis
 */
public interface RateStatistic {

    /**
     * Fired to record the occurrence of a monitored event.
     */
    void event();

    /**
     * Returns the total number of events that have occurred in the lifetime of this statistic.
     *
     * @return total number of events
     */
    long getCount();

    /**
     * Return the rate of events per unit time.
     *
     * @return event rate
     */
    float getRate();
}