blob: 2e07cb6763e6994717b11cc434a2e64a958ce3b0 (
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
|
/*
* 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;
import org.onosproject.event.ListenerService;
import org.onosproject.net.DeviceId;
import java.util.Collection;
/**
* Service for add/updating and removing meters. Meters are
* are assigned to flow to rate limit them and provide a certain
* quality of service.
*/
public interface MeterService
extends ListenerService<MeterEvent, MeterListener> {
/**
* Adds a meter to the system and performs it installation.
*
* @param meter a meter
* @return a meter (with a meter id)
*/
Meter submit(MeterRequest meter);
/**
* Remove a meter from the system and the dataplane.
*
* @param meter a meter to remove
* @param meterId the meter id of the meter to remove.
*/
void withdraw(MeterRequest meter, MeterId meterId);
/**
* Fetch the meter by the meter id.
*
* @param deviceId a device id
* @param id a meter id
* @return a meter
*/
Meter getMeter(DeviceId deviceId, MeterId id);
/**
* Fetches all the meters.
*
* @return a collection of meters
*/
Collection<Meter> getAllMeters();
}
|
