org.onosproject.incubator.net.l2monitoring.soam.delay

Interface DelayMeasurementEntry

All Superinterfaces:

DelayMeasurementCreate, MeasurementCreateBase

All Known Implementing Classes:

DefaultDelayMeasurementEntry

public interface DelayMeasurementEntry
extends DelayMeasurementCreate

Delay Measurement from ITU Y.1731 Chapter 8.2, MEF 17, MEF 36.1 and MEF 39. This represents the result returned and includes the parameters used to configure the DM when it was created

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DelayMeasurementEntry.DmEntryBuilder Builder for DelayMeasurementEntry.
static class	DelayMeasurementEntry.SessionStatus Session Status options.

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

DelayMeasurementCreate.DataPattern, DelayMeasurementCreate.DmCreateBuilder, DelayMeasurementCreate.DmType, DelayMeasurementCreate.MeasurementOption, DelayMeasurementCreate.TestTlvPattern, DelayMeasurementCreate.Version

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
DelayMeasurementStatCurrent	currentResult() The results for the current Measurement Interval in a SOAM Delay Measurement session.
SoamId	dmId() This uniquely identifies a scheduled measurement.
java.time.Duration	frameDelayBackward() The frame delay in the backward direction calculated by this MEP from the last received SOAM PDU.
java.time.Duration	frameDelayForward() The frame delay in the forward direction calculated by this MEP from the last received SOAM PDU.
java.time.Duration	frameDelayTwoWay() The two-way frame delay calculated by this MEP from the last received SOAM PDU.
java.util.Collection<DelayMeasurementStatHistory>	historicalResults() The results for history Measurement Intervals in a SOAM Delay Measurement session.
java.time.Duration	interFrameDelayVariationBackward() The last one-way inter-frame delay interval in the backward direction calculated by this MEP.
java.time.Duration	interFrameDelayVariationForward() The last one-way inter-frame delay interval in the forward direction calculated by this MEP.
java.time.Duration	interFrameDelayVariationTwoWay() The last two-way inter-frame delay interval calculated by this MEP.
DelayMeasurementEntry.SessionStatus	sessionStatus() The current status of the DM session.

Methods inherited from interface org.onosproject.incubator.net.l2monitoring.soam.delay.DelayMeasurementCreate

binsPerFdInterval, binsPerFdrInterval, binsPerIfdvInterval, dmCfgType, ifdvSelectionOffset, measurementsEnabled, thresholds

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

dmId

SoamId dmId()

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

Returns:

the id

sessionStatus

DelayMeasurementEntry.SessionStatus sessionStatus()

The current status of the DM session. A value of 'active' indicates the current DM session is active, i.e. the current time lies between the start time and the stop time, and enabled is true. A value of 'not-active' indicates the current DM session is not active, i.e. it has not started yet, has stopped upon reaching the stop time, or is disabled

Returns:

the status

frameDelayTwoWay

java.time.Duration frameDelayTwoWay()

The two-way frame delay calculated by this MEP from the last received SOAM PDU. This object is undefined is measurement-type is dm1-transmitted or dm1-received

Returns:

The delay as a java duration

frameDelayForward

java.time.Duration frameDelayForward()

The frame delay in the forward direction calculated by this MEP from the last received SOAM PDU. The value of this object may not be accurate in the absence of sufficiently precise clock synchronization. This object is undefined is measurement-type is dm1-transmitted

Returns:

The delay as a java duration

frameDelayBackward

java.time.Duration frameDelayBackward()

The frame delay in the backward direction calculated by this MEP from the last received SOAM PDU. The value of this object may not be accurate in the absence of sufficiently precise clock synchronization. This object is undefined is measurement-type is dm1-transmitted or dm1-received

Returns:

The delay as a java duration

interFrameDelayVariationTwoWay

java.time.Duration interFrameDelayVariationTwoWay()

The last two-way inter-frame delay interval calculated by this MEP. The value of this object is undefined when measurement-type is dm1-transmitted or dm1-received

Returns:

The delay as a java duration

interFrameDelayVariationForward

java.time.Duration interFrameDelayVariationForward()

The last one-way inter-frame delay interval in the forward direction calculated by this MEP. The value of this object is undefined when measurement-type is dm1-transmitted

Returns:

The delay as a java duration

interFrameDelayVariationBackward

java.time.Duration interFrameDelayVariationBackward()

The last one-way inter-frame delay interval in the backward direction calculated by this MEP. The value of this object is undefined when measurement-type is dm1-transmitted or dm1-received

Returns:

The delay as a java duration

currentResult

DelayMeasurementStatCurrent currentResult()

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

Returns:

The current set of results

historicalResults

java.util.Collection<DelayMeasurementStatHistory> historicalResults()

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

Returns:

A collection of history results