Package org.onosproject.net.meter

Interface MeterFeatures

  • All Known Implementing Classes:
    DefaultMeterFeatures
    public interface MeterFeatures
    Meter Features of a device.

    • Method Detail

      • deviceId

        DeviceId deviceId()
        Return the device id to which this meter features apply.
        Returns:
        the device id

      • maxMeter

        @Deprecated
long maxMeter()
        Deprecated.
        in onos-2.5 replaced by startIndex() and endIndex()
        Returns the maximum number of meters accepted by the device.
        Returns:
        the maximum meter value.

      • startIndex

        long startIndex()
        Returns the start index (inclusive) of the meters.
        Returns:
        the start index

      • endIndex

        long endIndex()
        Returns the end index (inclusive) of the meters.
        Returns:
        the end index

      • 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.

      • scope

        MeterScope scope()
        Returns Meter Scope.
        Returns:
        meter scope