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

Inheritance diagram for org.omg.dds.core.policy.LatencyBudget:

Collaboration diagram for org.omg.dds.core.policy.LatencyBudget:

Public Member Functions
Duration	getDuration ()

ServiceEnvironment	getEnvironment ()

Comparable< SELF >	requestedOfferedContract ()
	Use the object returned by this method to evaluate the Request/Offer relationship with another instance of this policy. More...

LatencyBudget	withDuration (Duration duration)
	Copy this policy and override the value of the property. More...

LatencyBudget	withDuration (long duration, TimeUnit unit)
	Copy this policy and override the value of the property. More...

Detailed Description

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: org.omg.dds.topic.Topic, org.omg.dds.sub.DataReader, org.omg.dds.pub.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.

Definition at line 52 of file LatencyBudget.java.

Member Function Documentation

◆ getDuration()

Duration org.omg.dds.core.policy.LatencyBudget.getDuration ( )

Implemented in org.opensplice.dds.core.policy.LatencyBudgetImpl.

◆ getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )

inherited

Returns: the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

◆ requestedOfferedContract()

Comparable<SELF> org.omg.dds.core.policy.RequestedOffered< SELF >.requestedOfferedContract ( )

inherited

Use the object returned by this method to evaluate the Request/Offer relationship with another instance of this policy.

If this policy is offered by a org.omg.dds.pub.DataWriter (or org.omg.dds.pub.Publisher), any other policy evaluated as less than or equal to it by the Comparable may be compatibly requested by a org.omg.dds.sub.DataReader (or org.omg.dds.sub.Subscriber). Similarly, if this policy is requested, any other policy that is greater than or equal to it may be compatibly offered.

Returns: a Comparable object capable of evaluating the Request/Offer relationship between two instances of the QoS policy identified by the type parameter SELF.

◆ withDuration() [1/2]

LatencyBudget org.omg.dds.core.policy.LatencyBudget.withDuration ( Duration duration )

Copy this policy and override the value of the property.

Parameters

duration Specifies a duration for the maximum acceptable additional delay from the time the data is written until the data is delivered.

Returns: a new LatencyBudget policy

Implemented in org.opensplice.dds.core.policy.LatencyBudgetImpl.

◆ withDuration() [2/2]

LatencyBudget org.omg.dds.core.policy.LatencyBudget.withDuration	(	long	duration,
		TimeUnit	unit
	)

Copy this policy and override the value of the property.

Parameters

duration	Specifies a long duration for the maximum acceptable additional delay from the time the data is written until the data is delivered.
unit	The TimeUnit which the duration describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)

Returns: a new policy

Implemented in org.opensplice.dds.core.policy.LatencyBudgetImpl.

The documentation for this interface was generated from the following file:

java5/common/java/code/org/omg/dds/core/policy/LatencyBudget.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ getDuration()

◆ getEnvironment()

◆ requestedOfferedContract()

◆ withDuration() [1/2]

◆ withDuration() [2/2]