org.omg.dds.core.policy

Interface LatencyBudget

All Superinterfaces:

Comparable<LatencyBudget>, DDSObject, QosPolicy, QosPolicy.ForDataReader, QosPolicy.ForDataWriter, QosPolicy.ForTopic, RequestedOffered<LatencyBudget>, Serializable

public interface LatencyBudget
extends QosPolicy.ForTopic, QosPolicy.ForDataReader, QosPolicy.ForDataWriter, RequestedOffered<LatencyBudget>

Specifies the maximum acceptable delay from the time the data is written until the data is inserted in the receiver's application cache and the receiving application is notified of the fact. This policy is a hint to the Service, not something that must be monitored or enforced. The Service is not required to track or alert the user of any violation. The default value of the duration is zero indicating that the delay should be minimized. Concerns: Topic, DataReader, DataWriter RxO: Yes Changeable: Yes This policy provides a means for the application to indicate to the middleware the "urgency" of the data communication. By having a non-zero duration the Service can optimize its internal operation. This policy is considered a hint. There is no specified mechanism as to how the service should take advantage of this hint. The value offered is considered compatible with the value requested if and only if the inequality "offered duration <= requested duration" evaluates to true.

Nested Class Summary

Nested classes/interfaces inherited from interface org.omg.dds.core.policy.QosPolicy

QosPolicy.ForDataReader, QosPolicy.ForDataWriter, QosPolicy.ForDomainParticipant, QosPolicy.ForDomainParticipantFactory, QosPolicy.ForPublisher, QosPolicy.ForSubscriber, QosPolicy.ForTopic

Method Summary

Methods

Modifier and Type	Method and Description
Duration	getDuration()
LatencyBudget	withDuration(Duration duration) Copy this policy and override the value of the property.
LatencyBudget	withDuration(long duration, TimeUnit unit) Copy this policy and override the value of the property.

Methods inherited from interface org.omg.dds.core.DDSObject

getEnvironment

Methods inherited from interface org.omg.dds.core.policy.RequestedOffered

requestedOfferedContract

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDuration

Duration getDuration()

withDuration

LatencyBudget withDuration(Duration duration)

Copy this policy and override the value of the property.

Returns:

a new policy

withDuration

LatencyBudget withDuration(long duration,
                         TimeUnit unit)

Copy this policy and override the value of the property.

Returns:

a new policy