Package org.onosproject.net.meter
Interface MeterFeatures
-
- All Known Implementing Classes:
DefaultMeterFeatures
public interface MeterFeaturesMeter Features of a device.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceMeterFeatures.BuilderA meter features builder.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Set<Band.Type>bandTypes()Returns band types supported.DeviceIddeviceId()Return the device id to which this meter features apply.java.util.Set<MeterFeaturesFlag>features()Returns features flags that supported for meter actions by device.booleanisBurstSupported()Returns if burst size is available.booleanisStatsSupported()Returns if statistics collection is available.shortmaxBands()Returns the maximum bands per meter.shortmaxColor()Returns the maximum colors value for DiffServ operation.longmaxMeter()Returns the maximum number of meters accepted by the device.java.util.Set<Meter.Unit>unitTypes()Returns unit types available for meters.
-
-
-
Method Detail
-
deviceId
DeviceId deviceId()
Return the device id to which this meter features apply.- Returns:
- the device id
-
maxMeter
long maxMeter()
Returns the maximum number of meters accepted by the device.- Returns:
- the maximum meter value.
-
bandTypes
java.util.Set<Band.Type> bandTypes()
Returns band types supported.- Returns:
- the band types supported.
-
unitTypes
java.util.Set<Meter.Unit> unitTypes()
Returns unit types available for meters.- Returns:
- the unit types available.
-
isBurstSupported
boolean isBurstSupported()
Returns if burst size is available.- Returns:
- burst availability
-
isStatsSupported
boolean isStatsSupported()
Returns if statistics collection is available.- Returns:
- statistics availability
-
maxBands
short maxBands()
Returns the maximum bands per meter.- Returns:
- the max bands value
-
maxColor
short maxColor()
Returns the maximum colors value for DiffServ operation.- Returns:
- the maximum colors value.
-
features
java.util.Set<MeterFeaturesFlag> features()
Returns features flags that supported for meter actions by device.- Returns:
- meter features flags otherwise empty set.
-
-