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

Interface LossMeasurementEntry

All Superinterfaces:

LossMeasurementCreate, MeasurementCreateBase

All Known Implementing Classes:

DefaultLmEntry

public interface LossMeasurementEntry
extends LossMeasurementCreate

A model of Loss Measurement from ITU Y.1731 Chapter 8.2, MEF 17, MEF 36.1 and MEF 39. In this model Loss Measurements entries are returned as a collection in the MepEntry. In this way Loss Measurements are created by calling on the Create Loss Measurement function, passing in any arguments needed to configure it. The Loss Measurement is a result and not configured or persisted in ONOS, but instead is is passed on to some analytics system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LossMeasurementEntry.AvailabilityType Options for Availability test types.
static interface	LossMeasurementEntry.LmEntryBuilder Builder for LossMeasurementEntry.

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

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.
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 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

Method Detail

lmId

SoamId lmId()

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

Returns:

An LM id

measuredForwardFlr

MilliPct measuredForwardFlr()

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).

Returns:

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

measuredBackwardFlr

MilliPct measuredBackwardFlr()

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).

Returns:

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

measuredAvailabilityForwardStatus

LossMeasurementEntry.AvailabilityType measuredAvailabilityForwardStatus()

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

Returns:

enumerated availability value

measuredAvailabilityBackwardStatus

LossMeasurementEntry.AvailabilityType measuredAvailabilityBackwardStatus()

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

Returns:

enumerated availability value

measuredForwardLastTransitionTime

java.time.Instant measuredForwardLastTransitionTime()

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

Returns:

The transition time

measuredBackwardLastTransitionTime

java.time.Instant measuredBackwardLastTransitionTime()

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

Returns:

The transition time

measurementCurrent

LossMeasurementStatCurrent measurementCurrent()

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

Returns:

An object with current measurements

measurementHistories

java.util.Collection<LossMeasurementStatHistory> measurementHistories()

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

Returns:

An object with historic measurements

availabilityCurrent

LossAvailabilityStatCurrent availabilityCurrent()

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

Returns:

An object with current availability

availabilityHistories

java.util.Collection<LossAvailabilityStatHistory> availabilityHistories()

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

Returns:

An object with historic availability