This policy is a hint to the infrastructure as to how to set the priority of the underlying transport used to send the data. More...

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

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

Public Member Functions
ServiceEnvironment	getEnvironment ()

int	getValue ()

TransportPriority	withValue (int value)
	Copy this policy and override the value of the property. More...

Detailed Description

This policy is a hint to the infrastructure as to how to set the priority of the underlying transport used to send the data.

The default value is zero.

Concerns: org.omg.dds.topic.Topic, org.omg.dds.pub.DataWriter

RxO: N/A

Changeable: Yes

The purpose of this QoS is to allow the application to take advantage of transports capable of sending messages with different priorities.

This policy is considered a hint. The policy depends on the ability of the underlying transports to set a priority on the messages they send. Any value within the range of a 32-bit signed integer may be chosen; higher values indicate higher priority. However, any further interpretation of this policy is specific to a particular transport and a particular implementation of the Service. For example, a particular transport is permitted to treat a range of priority values as equivalent to one another. It is expected that during transport configuration the application would provide a mapping between the values of the TRANSPORT_PRIORITY set on DataWriter and the values meaningful to each transport. This mapping would then be used by the infrastructure when propagating the data written by the DataWriter.

Definition at line 48 of file TransportPriority.java.

Member Function Documentation

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

◆ getValue()

int org.omg.dds.core.policy.TransportPriority.getValue ( )

Returns: the value

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

◆ withValue()

TransportPriority org.omg.dds.core.policy.TransportPriority.withValue ( int value )

Copy this policy and override the value of the property.

Parameters

value Specifies the priority with which the Data Distribution System can handle the data produced by the DataWriter.

Returns: a new TransportPriority policy