Package org.onosproject.net.meter

Class DefaultMeter

java.lang.Object

org.onosproject.net.AbstractAnnotated

org.onosproject.net.meter.DefaultMeter

All Implemented Interfaces:

Annotated, Meter, MeterEntry, PiTranslatable

public final class DefaultMeter
extends AbstractAnnotated
implements Meter, MeterEntry

A default implementation of a meter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultMeter.Builder

Nested classes/interfaces inherited from interface org.onosproject.net.meter.Meter

Meter.Unit

Method Summary

Modifier and Type	Method	Description
ApplicationId	appId()	The id of the application which created this meter.
Collection<Band>	bands()	The collection of bands to apply on the dataplane.
static DefaultMeter.Builder	builder()
long	bytesSeen()	Number of bytes processed by this meter.
DeviceId	deviceId()	The target device for this meter.
boolean	equals(Object o)
int	hashCode()
MeterId	id()	This meters id.
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.
void	setLife(long life)	Set the amount of time the meter has existed in seconds.
void	setProcessedBytes(long bytes)	Updates the number of bytes seen by the meter.
void	setProcessedPackets(long packets)	Updates the number of packets seen by this meter.
void	setReferenceCount(long count)	Sets the number of flows which are using this meter.
void	setState(MeterState state)	Updates the state of this meter.
MeterState	state()	Fetches the state of this meter.
String	toString()
Meter.Unit	unit()	The unit used within this meter.

Methods inherited from class org.onosproject.net.AbstractAnnotated

annotations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.onosproject.net.Annotated

annotations

Method Detail

deviceId

public DeviceId deviceId()

Description copied from interface: Meter

The target device for this meter.

Specified by:

deviceId in interface Meter

Returns:

a device id

id

public MeterId id()

Description copied from interface: Meter

This meters id.

Specified by:

id in interface Meter

Returns:

a meter id

meterCellId

public MeterCellId meterCellId()

Description copied from interface: Meter

Returns the meter cell identifier of this meter.

Specified by:

meterCellId in interface Meter

Returns:

a meter identifier

appId

public ApplicationId appId()

Description copied from interface: Meter

The id of the application which created this meter. Could be null if the meter is read from the controller southbound.

Specified by:

appId in interface Meter

Returns:

an application id

unit

public Meter.Unit unit()

Description copied from interface: Meter

The unit used within this meter.

Specified by:

unit in interface Meter

Returns:

the unit

isBurst

public boolean isBurst()

Description copied from interface: Meter

Signals whether this meter applies to bursts only.

Specified by:

isBurst in interface Meter

Returns:

a boolean

bands

public Collection<Band> bands()

Description copied from interface: Meter

The collection of bands to apply on the dataplane.

Specified by:

bands in interface Meter

Returns:

a collection of bands.

state

public MeterState state()

Description copied from interface: Meter

Fetches the state of this meter.

Specified by:

state in interface Meter

Returns:

a meter state

life

public long life()

Description copied from interface: Meter

The lifetime in seconds of this meter.

Specified by:

life in interface Meter

Returns:

number of seconds

referenceCount

public long referenceCount()

Description copied from interface: Meter

The number of flows pointing to this meter.

Specified by:

referenceCount in interface Meter

Returns:

a reference count

packetsSeen

public long packetsSeen()

Description copied from interface: Meter

Number of packets processed by this meter.

Specified by:

packetsSeen in interface Meter

Returns:

a packet count

bytesSeen

public long bytesSeen()

Description copied from interface: Meter

Number of bytes processed by this meter.

Specified by:

bytesSeen in interface Meter

Returns:

a byte count

builder

public static DefaultMeter.Builder builder()

setState

public void setState(MeterState state)

Description copied from interface: MeterEntry

Updates the state of this meter.

Specified by:

setState in interface MeterEntry

Parameters:

state - a meter state

setLife

public void setLife(long life)

Description copied from interface: MeterEntry

Set the amount of time the meter has existed in seconds.

Specified by:

setLife in interface MeterEntry

Parameters:

life - number of seconds

setReferenceCount

public void setReferenceCount(long count)

Description copied from interface: MeterEntry

Sets the number of flows which are using this meter.

Specified by:

setReferenceCount in interface MeterEntry

Parameters:

count - a reference count.

setProcessedPackets

public void setProcessedPackets(long packets)

Description copied from interface: MeterEntry

Updates the number of packets seen by this meter.

Specified by:

setProcessedPackets in interface MeterEntry

Parameters:

packets - a packet count.

setProcessedBytes

public void setProcessedBytes(long bytes)

Description copied from interface: MeterEntry

Updates the number of bytes seen by the meter.

Specified by:

setProcessedBytes in interface MeterEntry

Parameters:

bytes - a byte counter.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object