/hazelcast/src/main/java/com/hazelcast/monitor/LocalCountDownLatchOperationStats.java

 1/*
 2 * Copyright (c) 2008-2013, Hazelcast, Inc. All Rights Reserved.
 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
17package com.hazelcast.monitor;
18
19public interface LocalCountDownLatchOperationStats extends LocalInstanceOperationStats {
20
21    /**
22     * Returns the number of countDown operations in this period.
23     *
24     * @return number of acquire operations
25     */
26    public long getNumberOfCountDowns();
27
28    /**
29     * Returns the number of await operations in this period.
30     *
31     * @return number of await operations
32     */
33    public long getNumberOfAwaits();
34
35    /**
36     * Returns the number of operations other than await or countDown
37     * in this period.
38     *
39     * @return number of await operations
40     */
41    public long getNumberOfOthers();
42
43    /**
44     * Returns the total latency of await operations in this period.
45     * <p>To get the average latency, divide by the number of awaits.
46     * </p>
47     *
48     * @return total latency of all await operations
49     */
50    public long getTotalAwaitLatency();
51
52    /**
53     * Returns the total latency of countdown operations in this period.
54     * <p>To get the average latency, divide by the number of countdowns.
55     * </p>
56     *
57     * @return total latency of all countdown operations
58     */
59    public long getTotalCountDownLatency();
60
61    /**
62     * Returns the total latency of operations other than await or
63     * countdown in this period.
64     * <p>To get the average latency, divide by the number of others.
65     * </p>
66     *
67     * @return total latency of all await operations
68     */
69    public long getTotalOtherLatency();
70
71    /**
72     * Returns the number of times the count reached zero from a countdown
73     * operation in this period.
74     *
75     * @return number of attach operations
76     */
77    public long getNumberOfGatesOpened();
78
79    /**
80     * Returns the number of awaits released in this period from gate
81     * openings.
82     *
83     * @return number of awaits released
84     */
85    public long getNumberOfAwaitsReleased();
86}