org.onosproject.net.meter

Interface Meter

All Superinterfaces:

PiTranslatable

All Known Subinterfaces:

MeterEntry

All Known Implementing Classes:

DefaultMeter

public interface Meter
extends PiTranslatable

Represents a generalized meter cell configuration to be deployed on a device.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Meter.Builder A meter builder.
static class	Meter.Unit

Method Summary

Modifier and Type	Method and Description
ApplicationId	appId() The id of the application which created this meter.
Collection<Band>	bands() The collection of bands to apply on the dataplane.
long	bytesSeen() Number of bytes processed by this meter.
DeviceId	deviceId() The target device for this meter.
MeterId	id() Deprecated. in Nightingale release (version 1.13.0). Use meterCellId() instead.
boolean	isBurst() Signals whether this meter applies to bursts only.
long	life() The lifetime in seconds of this meter.
MeterCellId	meterCellId() Returns the meter cell identifier of this meter.
long	packetsSeen() Number of packets processed by this meter.
long	referenceCount() The number of flows pointing to this meter.
MeterState	state() Fetches the state of this meter.
Meter.Unit	unit() The unit used within this meter.

Method Detail

deviceId

DeviceId deviceId()

The target device for this meter.

Returns:

a device id

id

@Deprecated
MeterId id()

Deprecated. in Nightingale release (version 1.13.0). Use meterCellId() instead.

This meters id.

Returns:

a meter id

meterCellId

MeterCellId meterCellId()

Returns the meter cell identifier of this meter.

Returns:

a meter identifier

appId

ApplicationId appId()

The id of the application which created this meter.

Returns:

an application id

unit

Meter.Unit unit()

The unit used within this meter.

Returns:

the unit

isBurst

boolean isBurst()

Signals whether this meter applies to bursts only.

Returns:

a boolean

bands

Collection<Band> bands()

The collection of bands to apply on the dataplane.

Returns:

a collection of bands.

state

MeterState state()

Fetches the state of this meter.

Returns:

a meter state

life

long life()

The lifetime in seconds of this meter.

Returns:

number of seconds

referenceCount

long referenceCount()

The number of flows pointing to this meter.

Returns:

a reference count

packetsSeen

long packetsSeen()

Number of packets processed by this meter.

Returns:

a packet count

bytesSeen

long bytesSeen()

Number of bytes processed by this meter.

Returns:

a byte count