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

Class DefaultLmEntry

java.lang.Object

org.onosproject.incubator.net.l2monitoring.soam.DefaultMeasurementCreateBase

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

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

All Implemented Interfaces:

LossMeasurementCreate, LossMeasurementEntry, MeasurementCreateBase

public final class DefaultLmEntry
extends DefaultLmCreate
implements LossMeasurementEntry

The default implementation of LossMeasurementEntry.

Nested Class Summary

Nested classes/interfaces inherited from class org.onosproject.incubator.net.l2monitoring.soam.loss.DefaultLmCreate

DefaultLmCreate.DefaultLmCreateBuilder

Nested classes/interfaces inherited from class org.onosproject.incubator.net.l2monitoring.soam.DefaultMeasurementCreateBase

DefaultMeasurementCreateBase.DefaultMeasCreateBaseBuilder

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

LossMeasurementEntry.AvailabilityType, LossMeasurementEntry.LmEntryBuilder

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

LossMeasurementCreate.CounterOption, LossMeasurementCreate.LmCreateBuilder, LossMeasurementCreate.LmType

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

MeasurementCreateBase.MeasCreateBaseBuilder, MeasurementCreateBase.SessionType

Field Summary

Fields inherited from class org.onosproject.incubator.net.l2monitoring.soam.DefaultMeasurementCreateBase

alignMeasurementIntervals, alignMeasurementOffset, dataPattern, frameSize, measurementInterval, messagePeriod, numberIntervalsStored, priority, remoteMepId, sessionType, startTime, stopTime, testTlvIncluded, testTlvPattern, version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultLmEntry(org.onosproject.incubator.net.l2monitoring.soam.loss.DefaultLmEntry.DefaultLmEntryBuilder builder)

Method Summary

Modifier and Type	Method and Description
LossAvailabilityStatCurrent	availabilityCurrent() The current results for a SOAM Loss Measurement session for availability statistics.
java.util.Collection<LossAvailabilityStatHistory>	availabilityHistories() The results for availability history Measurement Intervals in a SOAM Loss Measurement session.
static LossMeasurementEntry.LmEntryBuilder	builder(DelayMeasurementCreate.Version version, MepId remoteMepId, Mep.Priority priority, LossMeasurementCreate.LmType lmCfgType, SoamId lmId)
SoamId	lmId() Ian id that uniquely identifies a scheduled measurement.
LossMeasurementEntry.AvailabilityType	measuredAvailabilityBackwardStatus() The availability status (the outcome of the last availability indicator) in the backward direction.
LossMeasurementEntry.AvailabilityType	measuredAvailabilityForwardStatus() The availability status (the outcome of the last availability indicator) in the forward direction.
MilliPct	measuredBackwardFlr() Contains the Frame Loss Ratio in the backward direction calculated by this MEP.
java.time.Instant	measuredBackwardLastTransitionTime() The time of the last transition between available and unavailable in the backward direction.
MilliPct	measuredForwardFlr() Contains the Frame Loss Ratio in the forward direction calculated by this MEP.
java.time.Instant	measuredForwardLastTransitionTime() The time of the last transition between available and unavailable in the forward direction.
LossMeasurementStatCurrent	measurementCurrent() The results for the current Measurement Interval in a SOAM Loss Measurement session.
java.util.Collection<LossMeasurementStatHistory>	measurementHistories() The results for history Measurement Intervals in a SOAM Loss Measurement session.

Methods inherited from class org.onosproject.incubator.net.l2monitoring.soam.loss.DefaultLmCreate

availabilityFlrThreshold, availabilityMeasurementInterval, availabilityNumberConsecutiveFlrMeasurements, availabilityNumberConsecutiveHighFlr, availabilityNumberConsecutiveIntervals, builder, countersEnabled, lmCfgType, lossMeasurementThreshold

Methods inherited from class org.onosproject.incubator.net.l2monitoring.soam.DefaultMeasurementCreateBase

alignMeasurementIntervals, alignMeasurementOffset, dataPattern, frameSize, measurementInterval, messagePeriod, numberIntervalsStored, priority, remoteMepId, sessionType, startTime, stopTime, testTlvIncluded, testTlvPattern, version

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.incubator.net.l2monitoring.soam.loss.LossMeasurementCreate

availabilityFlrThreshold, availabilityMeasurementInterval, availabilityNumberConsecutiveFlrMeasurements, availabilityNumberConsecutiveHighFlr, availabilityNumberConsecutiveIntervals, countersEnabled, lmCfgType, lossMeasurementThreshold

Methods inherited from interface org.onosproject.incubator.net.l2monitoring.soam.MeasurementCreateBase

alignMeasurementIntervals, alignMeasurementOffset, dataPattern, frameSize, measurementInterval, messagePeriod, numberIntervalsStored, priority, remoteMepId, sessionType, startTime, stopTime, testTlvIncluded, testTlvPattern, version

Constructor Detail

DefaultLmEntry

protected DefaultLmEntry(org.onosproject.incubator.net.l2monitoring.soam.loss.DefaultLmEntry.DefaultLmEntryBuilder builder)

Method Detail

lmId

public SoamId lmId()

Description copied from interface: LossMeasurementEntry

Ian id that uniquely identifies a scheduled measurement. It is automatically generated by the server on creation of a new measurement

Specified by:

lmId in interface LossMeasurementEntry

Returns:

An LM id

measuredForwardFlr

public MilliPct measuredForwardFlr()

Description copied from interface: LossMeasurementEntry

Contains the Frame Loss Ratio in the forward direction calculated by this MEP. from the last received SOAM PDU. The FLR value is a ratio that is expressed as a percent with a value of 0 (ratio 0.00) through 100000 (ratio 1.00).

Specified by:

measuredForwardFlr in interface LossMeasurementEntry

Returns:

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

measuredBackwardFlr

public MilliPct measuredBackwardFlr()

Description copied from interface: LossMeasurementEntry

Contains the Frame Loss Ratio in the backward direction calculated by this MEP. from the last received SOAM PDU. The FLR value is a ratio that is expressed as a percent with a value of 0 (ratio 0.00) through 100000 (ratio 1.00).

Specified by:

measuredBackwardFlr in interface LossMeasurementEntry

Returns:

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

measuredAvailabilityForwardStatus

public LossMeasurementEntry.AvailabilityType measuredAvailabilityForwardStatus()

Description copied from interface: LossMeasurementEntry

The availability status (the outcome of the last availability indicator) in the forward direction. based upon the last received SOAM PDU

Specified by:

measuredAvailabilityForwardStatus in interface LossMeasurementEntry

Returns:

enumerated availability value

measuredAvailabilityBackwardStatus

public LossMeasurementEntry.AvailabilityType measuredAvailabilityBackwardStatus()

Description copied from interface: LossMeasurementEntry

The availability status (the outcome of the last availability indicator) in the backward direction. based upon the last received SOAM PDU

Specified by:

measuredAvailabilityBackwardStatus in interface LossMeasurementEntry

Returns:

enumerated availability value

measuredForwardLastTransitionTime

public java.time.Instant measuredForwardLastTransitionTime()

Description copied from interface: LossMeasurementEntry

The time of the last transition between available and unavailable in the forward direction. If there have been no transitions since the Loss Measurement Session was started, this is set to 0

Specified by:

measuredForwardLastTransitionTime in interface LossMeasurementEntry

Returns:

The transition time

measuredBackwardLastTransitionTime

public java.time.Instant measuredBackwardLastTransitionTime()

Description copied from interface: LossMeasurementEntry

The time of the last transition between available and unavailable in the backward direction. If there have been no transitions since the Loss Measurement Session was started, this is set to 0

Specified by:

measuredBackwardLastTransitionTime in interface LossMeasurementEntry

Returns:

The transition time

measurementCurrent

public LossMeasurementStatCurrent measurementCurrent()

Description copied from interface: LossMeasurementEntry

The results for the current Measurement Interval in a SOAM Loss Measurement session. gathered during the interval indicated by measurement-interval

Specified by:

measurementCurrent in interface LossMeasurementEntry

Returns:

An object with current measurements

measurementHistories

public java.util.Collection<LossMeasurementStatHistory> measurementHistories()

Description copied from interface: LossMeasurementEntry

The results for history Measurement Intervals in a SOAM Loss Measurement session.

Specified by:

measurementHistories in interface LossMeasurementEntry

Returns:

An object with historic measurements

availabilityCurrent

public LossAvailabilityStatCurrent availabilityCurrent()

Description copied from interface: LossMeasurementEntry

The current results for a SOAM Loss Measurement session for availability statistics. gathered during the interval indicated by availability-measurement-interval

Specified by:

availabilityCurrent in interface LossMeasurementEntry

Returns:

An object with current availability

availabilityHistories

public java.util.Collection<LossAvailabilityStatHistory> availabilityHistories()

Description copied from interface: LossMeasurementEntry

The results for availability history Measurement Intervals in a SOAM Loss Measurement session.

Specified by:

availabilityHistories in interface LossMeasurementEntry

Returns:

An object with historic availability

builder

public static LossMeasurementEntry.LmEntryBuilder builder(DelayMeasurementCreate.Version version,
                                                          MepId remoteMepId,
                                                          Mep.Priority priority,
                                                          LossMeasurementCreate.LmType lmCfgType,
                                                          SoamId lmId)
                                                   throws SoamConfigException

Throws:

SoamConfigException