Package org.onosproject.net.meter

Enum Band.Type

java.lang.Object

java.lang.Enum<Band.Type>

org.onosproject.net.meter.Band.Type

All Implemented Interfaces:

Serializable, Comparable<Band.Type>

Enclosing interface:

Band

public static enum Band.Type
extends 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.
MARK_RED	Defines a meter band for the configuration of the peak rate AND the peak burst size OR the excess burst size.
MARK_YELLOW	Defines a meter band for the configuration of the committed rate AND the committed burst size.
NONE	Deprecated. in onos-2.5, replace by MARK_YELLOW and MARK_RED
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

Modifier and Type	Method	Description
static Band.Type	valueOf(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

@Deprecated
public static final Band.Type NONE

Deprecated.

in onos-2.5, replace by MARK_YELLOW and MARK_RED

Defines a meter band with no action, used to mark packets internally in the pipeline, i.e. without modifying the packet headers.

MARK_YELLOW

public static final Band.Type MARK_YELLOW

Defines a meter band for the configuration of the committed rate AND the committed burst size. Used in conjunction with MARK_RED to implement a srTCM or trTCM, see RFCs 2697 and 2698 respectively.

MARK_RED

public static final Band.Type MARK_RED

Defines a meter band for the configuration of the peak rate AND the peak burst size OR the excess burst size. When used to configure a srTCM excess rate must be 0. Used in conjunction with MARK_YELLOW to implement a srTCM or trTCM, see RFCs 2697 and 2698 respectively.

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(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null