Package org.onosproject.net.meter

Enum Band.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Band.Type>
    Enclosing interface:
    Band
    public static enum Band.Type
extends java.lang.Enum<Band.Type>
    Specifies the type of band.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DROP
      Simple rate limiter which drops packets when the rate is exceeded.
      EXPERIMENTAL
      Defines an experimental meter band.
      NONE
      Defines a meter band with no action, used to mark packets internally in the pipeline, i.e.
      REMARK
      Defines a simple DiffServ policer that remark the drop precedence of the DSCP field in the IP header of the packets that exceed the band rate value.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Band.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Band.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • DROP

        public static final Band.Type DROP
        Simple rate limiter which drops packets when the rate is exceeded.

      • REMARK

        public static final Band.Type REMARK
        Defines a simple DiffServ policer that remark the drop precedence of the DSCP field in the IP header of the packets that exceed the band rate value.

      • EXPERIMENTAL

        public static final Band.Type EXPERIMENTAL
        Defines an experimental meter band.

      • NONE

        public static final Band.Type NONE
        Defines a meter band with no action, used to mark packets internally in the pipeline, i.e. without modifying the packet headers.

    • Method Detail

      • values

        public static Band.Type[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Band.Type c : Band.Type.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Band.Type valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null