org.onosproject.incubator.net.l2monitoring.soam.loss

Class DefaultLmThreshold

java.lang.Object

org.onosproject.incubator.net.l2monitoring.soam.loss.DefaultLmThreshold

All Implemented Interfaces:

LossMeasurementThreshold

public final class DefaultLmThreshold
extends java.lang.Object
implements LossMeasurementThreshold

The default implementation of LossMeasurementThreshold.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.incubator.net.l2monitoring.soam.loss.LossMeasurementThreshold

LossMeasurementThreshold.LmThresholdBuilder, LossMeasurementThreshold.ThresholdOption

Method Summary

Modifier and Type	Method and Description
MilliPct	averageFlrBackward() The average backward frame loss ratio threshold value.
MilliPct	averageFlrForward() The average forward frame loss ratio threshold value.
MilliPct	backwardAvailableRatio() The backward availability/total time ratio threshold value.
java.lang.Long	backwardConsecutiveHighLoss() The consecutive backward high loss threshold value.
java.lang.Long	backwardHighLoss() The backward high loss threshold value.
java.lang.Long	backwardUnavailableCount() The backward unavailability threshold value.
static LossMeasurementThreshold.LmThresholdBuilder	builder(SoamId thresholdId)
MilliPct	forwardAvailableRatio() The forward availability/total time ratio threshold value.
java.lang.Long	forwardConsecutiveHighLoss() The consecutive forward high loss threshold value.
java.lang.Long	forwardHighLoss() The forward high loss threshold value.
java.lang.Long	forwardUnavailableCount() The forward unavailability threshold value.
MilliPct	maxFlrBackward() The maximum backward frame loss ratio threshold value.
MilliPct	maxFlrForward() The maximum forward frame loss ratio threshold value.
MilliPct	measuredFlrBackward() The measured backward frame loss ratio threshold value.
MilliPct	measuredFlrForward() The measured forward frame loss ratio threshold value.
SoamId	thresholdId() The index of the threshold number for the specific LM threshold entry.
java.util.Collection<LossMeasurementThreshold.ThresholdOption>	thresholds() A vector of bits that indicates the type of SOAM LM thresholds notifications that are enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

thresholdId

public SoamId thresholdId()

Description copied from interface: LossMeasurementThreshold

The index of the threshold number for the specific LM threshold entry. An index value of '1' needs to be supported. Other index values can also be supported

Specified by:

thresholdId in interface LossMeasurementThreshold

Returns:

The threshold Id

thresholds

public java.util.Collection<LossMeasurementThreshold.ThresholdOption> thresholds()

Description copied from interface: LossMeasurementThreshold

A vector of bits that indicates the type of SOAM LM thresholds notifications that are enabled. A present but enables the specific SOAM LM threshold notification and when the specific counter is enabled and the threshold is crossed a notification is generated. A not present bit disables the specific SOAM LM threshold notification. If a particular SOAM LM threshold is not supported the BIT value is not present

Specified by:

thresholds in interface LossMeasurementThreshold

Returns:

A collection of bit options

measuredFlrForward

public MilliPct measuredFlrForward()

Description copied from interface: LossMeasurementThreshold

The measured forward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated

Specified by:

measuredFlrForward in interface LossMeasurementThreshold

Returns:

Units are in milli-percent, where 1 indicates 0.001 percent

maxFlrForward

public MilliPct maxFlrForward()

Description copied from interface: LossMeasurementThreshold

The maximum forward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated

Specified by:

maxFlrForward in interface LossMeasurementThreshold

Returns:

Units are in milli-percent, where 1 indicates 0.001 percent

averageFlrForward

public MilliPct averageFlrForward()

Description copied from interface: LossMeasurementThreshold

The average forward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated

Specified by:

averageFlrForward in interface LossMeasurementThreshold

Returns:

Units are in milli-percent, where 1 indicates 0.001 percent

measuredFlrBackward

public MilliPct measuredFlrBackward()

Description copied from interface: LossMeasurementThreshold

The measured backward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated

Specified by:

measuredFlrBackward in interface LossMeasurementThreshold

Returns:

Units are in milli-percent, where 1 indicates 0.001 percent

maxFlrBackward

public MilliPct maxFlrBackward()

Description copied from interface: LossMeasurementThreshold

The maximum backward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated

Specified by:

maxFlrBackward in interface LossMeasurementThreshold

Returns:

Units are in milli-percent, where 1 indicates 0.001 percent

averageFlrBackward

public MilliPct averageFlrBackward()

Description copied from interface: LossMeasurementThreshold

The average backward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated

Specified by:

averageFlrBackward in interface LossMeasurementThreshold

Returns:

Units are in milli-percent, where 1 indicates 0.001 percent

forwardHighLoss

public java.lang.Long forwardHighLoss()

Description copied from interface: LossMeasurementThreshold

The forward high loss threshold value. that will be used to determine if a threshold notification is generated.

Specified by:

forwardHighLoss in interface LossMeasurementThreshold

Returns:

The threshold value

forwardConsecutiveHighLoss

public java.lang.Long forwardConsecutiveHighLoss()

Description copied from interface: LossMeasurementThreshold

The consecutive forward high loss threshold value. that will be used to determine if a threshold notification is generated

Specified by:

forwardConsecutiveHighLoss in interface LossMeasurementThreshold

Returns:

The threshold value

backwardHighLoss

public java.lang.Long backwardHighLoss()

Description copied from interface: LossMeasurementThreshold

The backward high loss threshold value. that will be used to determine if a threshold notification is generated.

Specified by:

backwardHighLoss in interface LossMeasurementThreshold

Returns:

The threshold value

backwardConsecutiveHighLoss

public java.lang.Long backwardConsecutiveHighLoss()

Description copied from interface: LossMeasurementThreshold

The consecutive backward high loss threshold value. that will be used to determine if a threshold notification is generated

Specified by:

backwardConsecutiveHighLoss in interface LossMeasurementThreshold

Returns:

The threshold value

forwardUnavailableCount

public java.lang.Long forwardUnavailableCount()

Description copied from interface: LossMeasurementThreshold

The forward unavailability threshold value. that will be used to determine if a threshold notification is generated

Specified by:

forwardUnavailableCount in interface LossMeasurementThreshold

Returns:

The threshold value

forwardAvailableRatio

public MilliPct forwardAvailableRatio()

Description copied from interface: LossMeasurementThreshold

The forward availability/total time ratio threshold value. that will be used to determine if a threshold notification is generated if the ratio drops below the configured value. The ratio value is expressed as a percent with a value of 0 (ratio 0.00) through 100000 (ratio 1.00)

Specified by:

forwardAvailableRatio in interface LossMeasurementThreshold

Returns:

Units are in milli-percent, where 1 indicates 0.001 percent

backwardUnavailableCount

public java.lang.Long backwardUnavailableCount()

Description copied from interface: LossMeasurementThreshold

The backward unavailability threshold value. that will be used to determine if a threshold notification is generated

Specified by:

backwardUnavailableCount in interface LossMeasurementThreshold

Returns:

The threshold value

backwardAvailableRatio

public MilliPct backwardAvailableRatio()

Description copied from interface: LossMeasurementThreshold

The backward availability/total time ratio threshold value. that will be used to determine if a threshold notification is generated if the ratio drops below the configured value. The ratio value is expressed as a percent with a value of 0 (ratio 0.00) through 100000 (ratio 1.00)

Specified by:

backwardAvailableRatio in interface LossMeasurementThreshold

Returns:

Units are in milli-percent, where 1 indicates 0.001 percent

builder

public static LossMeasurementThreshold.LmThresholdBuilder builder(SoamId thresholdId)