| /* |
| * Copyright 2015-present Open Networking Foundation |
| * |
| * 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.Annotated; |
| import org.onosproject.net.Annotations; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.pi.service.PiTranslatable; |
| |
| import java.util.Collection; |
| |
| /** |
| * Represents a generalized meter cell configuration to be deployed on a device. |
| */ |
| public interface Meter extends PiTranslatable, Annotated { |
| |
| enum Unit { |
| /** |
| * Packets per second. |
| */ |
| PKTS_PER_SEC, |
| |
| /** |
| * Kilo bits per second. |
| */ |
| KB_PER_SEC, |
| |
| /** |
| * Bytes per second. |
| */ |
| BYTES_PER_SEC |
| } |
| |
| /** |
| * The target device for this meter. |
| * |
| * @return a device id |
| */ |
| DeviceId deviceId(); |
| |
| /** |
| * This meters id. |
| * |
| * @return a meter id |
| * @deprecated in Nightingale release (version 1.13.0). Use {@link #meterCellId()} instead. |
| */ |
| @Deprecated |
| MeterId id(); |
| |
| /** |
| * Returns the meter cell identifier of this meter. |
| * |
| * @return a meter identifier |
| */ |
| MeterCellId meterCellId(); |
| |
| /** |
| * The id of the application which created this meter. |
| * Could be null if the meter is read from the controller southbound. |
| * |
| * @return an application id |
| */ |
| ApplicationId appId(); |
| // TODO: Deprecate this and create a new method returns an Optional ApplicationId |
| // TODO: Or introduce MeterEntry on south and keep this method |
| |
| /** |
| * 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 |
| * @deprecated in Nightingale release (version 1.13.0). Use {@link |
| * #withCellId(MeterCellId)} instead. |
| */ |
| @Deprecated |
| Builder withId(MeterId id); |
| |
| /** |
| * Assigns the id to this meter cell. |
| * |
| * @param meterId a meter cell identifier |
| * @return this |
| */ |
| Builder withCellId(MeterCellId meterId); |
| |
| /** |
| * 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); |
| |
| /** |
| * Sets the annotations. |
| * |
| * @param annotations annotations |
| * @return builder object |
| */ |
| Builder withAnnotations(Annotations annotations); |
| |
| /** |
| * Builds the meter based on the specified parameters. |
| * |
| * @return a meter |
| */ |
| Meter build(); |
| } |
| |
| } |