1 /***
2 * Copyright 2003-2010 Terracotta, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package net.sf.ehcache.util.ratestatistics;
18
19 /***
20 * Rate monitoring statistic.
21 *
22 * @author Chris Dennis
23 */
24 public interface RateStatistic {
25
26 /***
27 * Fired to record the occurrence of a monitored event.
28 */
29 void event();
30
31 /***
32 * Returns the total number of events that have occurred in the lifetime of this statistic.
33 *
34 * @return total number of events
35 */
36 long getCount();
37
38 /***
39 * Return the rate of events per unit time.
40 *
41 * @return event rate
42 */
43 float getRate();
44 }