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

Class DefaultDelayMeasurementEntry

java.lang.Object

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

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

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

All Implemented Interfaces:

DelayMeasurementCreate, DelayMeasurementEntry, MeasurementCreateBase

public final class DefaultDelayMeasurementEntry
extends DefaultDelayMeasurementCreate
implements DelayMeasurementEntry

The default implementation of DelayMeasurementEntry.

Nested Class Summary

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

DefaultDelayMeasurementCreate.DefaultDmCreateBuilder

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

DelayMeasurementEntry.DmEntryBuilder, DelayMeasurementEntry.SessionStatus

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

Field Summary

Fields inherited from class org.onosproject.incubator.net.l2monitoring.soam.delay.DefaultDelayMeasurementCreate

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

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

Method Summary

Modifier and Type	Method and Description
static DelayMeasurementEntry.DmEntryBuilder	builder(SoamId dmId, DelayMeasurementCreate.DmType dmCfgType, DelayMeasurementCreate.Version version, MepId remoteMepId, Mep.Priority priority)
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 class org.onosproject.incubator.net.l2monitoring.soam.delay.DefaultDelayMeasurementCreate

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

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

public SoamId dmId()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

dmId in interface DelayMeasurementEntry

Returns:

the id

sessionStatus

public DelayMeasurementEntry.SessionStatus sessionStatus()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

sessionStatus in interface DelayMeasurementEntry

Returns:

the status

frameDelayTwoWay

public java.time.Duration frameDelayTwoWay()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

frameDelayTwoWay in interface DelayMeasurementEntry

Returns:

The delay as a java duration

frameDelayForward

public java.time.Duration frameDelayForward()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

frameDelayForward in interface DelayMeasurementEntry

Returns:

The delay as a java duration

frameDelayBackward

public java.time.Duration frameDelayBackward()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

frameDelayBackward in interface DelayMeasurementEntry

Returns:

The delay as a java duration

interFrameDelayVariationTwoWay

public java.time.Duration interFrameDelayVariationTwoWay()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

interFrameDelayVariationTwoWay in interface DelayMeasurementEntry

Returns:

The delay as a java duration

interFrameDelayVariationForward

public java.time.Duration interFrameDelayVariationForward()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

interFrameDelayVariationForward in interface DelayMeasurementEntry

Returns:

The delay as a java duration

interFrameDelayVariationBackward

public java.time.Duration interFrameDelayVariationBackward()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

interFrameDelayVariationBackward in interface DelayMeasurementEntry

Returns:

The delay as a java duration

currentResult

public DelayMeasurementStatCurrent currentResult()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

currentResult in interface DelayMeasurementEntry

Returns:

The current set of results

historicalResults

public java.util.Collection<DelayMeasurementStatHistory> historicalResults()

Description copied from interface: DelayMeasurementEntry

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

Specified by:

historicalResults in interface DelayMeasurementEntry

Returns:

A collection of history results

builder

public static DelayMeasurementEntry.DmEntryBuilder builder(SoamId dmId,
                                                           DelayMeasurementCreate.DmType dmCfgType,
                                                           DelayMeasurementCreate.Version version,
                                                           MepId remoteMepId,
                                                           Mep.Priority priority)
                                                    throws SoamConfigException

Throws:

SoamConfigException