org.onosproject.net.meter

Interface MeterFeatures

All Known Implementing Classes:

DefaultMeterFeatures

public interface MeterFeatures

Meter Features of a device.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MeterFeatures.Builder A meter features builder.

Method Summary

Modifier and Type	Method and Description
Set<Band.Type>	bandTypes() Returns band types supported.
DeviceId	deviceId() Return the device id to which this meter features apply.
Set<MeterFeaturesFlag>	features() Returns features flags that supported for meter actions by device.
boolean	isBurstSupported() Returns if burst size is available.
boolean	isStatsSupported() Returns if statistics collection is available.
short	maxBands() Returns the maximum bands per meter.
short	maxColor() Returns the maximum colors value for DiffServ operation.
long	maxMeter() Returns the maximum number of meters accepted by the device.
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

Set<Band.Type> bandTypes()

Returns band types supported.

Returns:

the band types supported.

unitTypes

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

Set<MeterFeaturesFlag> features()

Returns features flags that supported for meter actions by device.

Returns:

meter features flags otherwise empty set.