Band (ONOS Java API (2.2.3))

All Known Subinterfaces:

BandEntry

All Known Implementing Classes:

DefaultBand
```
public interface Band
```
Represents a band used within a meter.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface Band.Builder

static class Band.Type
Specifies the type of band.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String ERR_MSG

static short MAX_PRECEDENCE

static short MIN_PRECEDENCE

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.Long`	`burst()`	The burst size at which the meter applies.
`long`	`bytes()`	Return the bytes seen by this band.
`java.lang.Short`	`dropPrecedence()`	Only meaningful in the case of a REMARK band type.
`long`	`packets()`	Returns the packets seen by this band.
`long`	`rate()`	The rate at which this meter applies.
`Band.Type`	`type()`	Signals the type of band to create.

- Field Detail
  - MIN_PRECEDENCE
```
static final short MIN_PRECEDENCE
```
    See Also:
    
    Constant Field Values
  - MAX_PRECEDENCE
```
static final short MAX_PRECEDENCE
```
    See Also:
    
    Constant Field Values
  - ERR_MSG
```
static final java.lang.String ERR_MSG
```
    See Also:
    
    Constant Field Values
- Method Detail
  - rate
```
long rate()
```
    The rate at which this meter applies.
    
    Returns:
    
    the long value of the rate
  - burst
```
java.lang.Long burst()
```
    The burst size at which the meter applies.
    
    Returns:
    
    the long value of the size
  - dropPrecedence
```
java.lang.Short dropPrecedence()
```
    Only meaningful in the case of a REMARK band type. indicates by which amount the drop precedence of the packet should be increase if the band is exceeded.
    
    Returns:
    
    a short value
  - type
```
Band.Type type()
```
    Signals the type of band to create.
    
    Returns:
    
    a band type
  - packets
```
long packets()
```
    Returns the packets seen by this band.
    
    Returns:
    
    a long value
  - bytes
```
long bytes()
```
    Return the bytes seen by this band.
    
    Returns:
    
    a byte counter