diff options
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/meter/Meter.java')
| -rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/meter/Meter.java | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/meter/Meter.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/meter/Meter.java new file mode 100644 index 00000000..98ebc350 --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/meter/Meter.java @@ -0,0 +1,179 @@ +/* + * 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.core.ApplicationId; +import org.onosproject.net.DeviceId; + +import java.util.Collection; + +/** + * Represents a generalized meter to be deployed on a device. + */ +public interface Meter { + + enum Unit { + /** + * Packets per second. + */ + PKTS_PER_SEC, + + /** + * Kilo bits per second. + */ + KB_PER_SEC + } + + /** + * The target device for this meter. + * + * @return a device id + */ + DeviceId deviceId(); + + /** + * This meters id. + * + * @return a meter id + */ + MeterId id(); + + /** + * The id of the application which created this meter. + * + * @return an application id + */ + ApplicationId appId(); + + /** + * The unit used within this meter. + * + * @return the unit + */ + Unit unit(); + + /** + * Signals whether this meter applies to bursts only. + * + * @return a boolean + */ + boolean isBurst(); + + /** + * The collection of bands to apply on the dataplane. + * + * @return a collection of bands. + */ + Collection<Band> bands(); + + /** + * Fetches the state of this meter. + * + * @return a meter state + */ + MeterState state(); + + /** + * The lifetime in seconds of this meter. + * + * @return number of seconds + */ + long life(); + + /** + * The number of flows pointing to this meter. + * + * @return a reference count + */ + long referenceCount(); + + /** + * Number of packets processed by this meter. + * + * @return a packet count + */ + long packetsSeen(); + + /** + * Number of bytes processed by this meter. + * + * @return a byte count + */ + long bytesSeen(); + + /** + * A meter builder. + */ + interface Builder { + + /** + * Assigns the target device for this meter. + * + * @param deviceId a device id + * @return this + */ + Builder forDevice(DeviceId deviceId); + + /** + * Assigns the id to this meter. + * + * @param id a e + * @return this + */ + Builder withId(MeterId id); + + /** + * Assigns the application that built this meter. + * + * @param appId an application id + * @return this + */ + Builder fromApp(ApplicationId appId); + + /** + * Assigns the @See Unit to use for this meter. + * Defaults to kb/s + * + * @param unit a unit + * @return this + */ + Builder withUnit(Unit unit); + + /** + * Sets this meter as applicable to burst traffic only. + * Defaults to false. + * + * @return this + */ + Builder burst(); + + /** + * Assigns bands to this meter. There must be at least one band. + * + * @param bands a collection of bands + * @return this + */ + Builder withBands(Collection<Band> bands); + + /** + * Builds the meter based on the specified parameters. + * + * @return a meter + */ + Meter build(); + } + +} |