blob: 2bfafad209f3bccdc792a88e2118855d96965714 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/*
* Copyright 2015 Open Networking Laboratory
*
* 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 org.onosproject.net.meter;
/**
* Represents a band used within a meter.
*/
public interface Band {
/**
* Specifies the type of band.
*/
enum Type {
/**
* Simple rate limiter which drops packets
* when the rate is exceeded.
*/
DROP,
/**
* defines a simple DiffServ policer that remark
* the drop precedence of the DSCP field in the
* IP header of the packets that exceed the band
* rate value.
*/
REMARK
}
/**
* The rate at which this meter applies.
*
* @return the long value of the rate
*/
long rate();
/**
* The burst size at which the meter applies.
*
* @return the long value of the size
*/
long burst();
/**
* Only meaningful in the case of a REMARK band type.
* indicates by which amount the drop precedence of
* the packet should be increase if the band is exceeded.
*
* @return a short value
*/
short dropPrecedence();
/**
* Signals the type of band to create.
*
* @return a band type
*/
Type type();
/**
* Returns the packets seen by this band.
*
* @return a long value
*/
long packets();
/**
* Return the bytes seen by this band.
*
* @return a byte counter
*/
long bytes();
interface Builder {
/**
* Assigns a rate to this band. The units for this rate
* are defined in the encapsulating meter.
*
* @param rate a long value
* @return this
*/
Builder withRate(long rate);
/**
* Assigns a burst size to this band. Only meaningful if
* the encapsulating meter is of burst type.
*
* @param burstSize a long value.
* @return this
*/
Builder burstSize(long burstSize);
/**
* Assigns the drop precedence for this band. Only meaningful if
* the band is of REMARK type.
*
* @param prec a short value
* @return this
*/
Builder dropPrecedence(short prec);
/**
* Assigns the @See Type of this band.
*
* @param type a band type
* @return this
*/
Builder ofType(Type type);
/**
* Builds the band.
*
* @return a band
*/
Band build();
}
}
|
