This class is the abstract root for all the QoS policies. More...

Inherits Serializable, and org.omg.dds.core.DDSObject.

Inherited by org.omg.dds.core.policy.QosPolicy.ForDataReader, org.omg.dds.core.policy.QosPolicy.ForDataWriter, org.omg.dds.core.policy.QosPolicy.ForDomainParticipant, org.omg.dds.core.policy.QosPolicy.ForDomainParticipantFactory, org.omg.dds.core.policy.QosPolicy.ForPublisher, org.omg.dds.core.policy.QosPolicy.ForSubscriber, org.omg.dds.core.policy.QosPolicy.ForTopic, org.opensplice.dds.core.policy.QosPolicy, org.opensplice.dds.core.policy.QosPolicy.ForView, and org.opensplice.dds.core.policy.QosPolicyImpl.

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

Classes
interface	ForDataReader
	A QosPolicy interface that implements this marker interface applies to org.omg.dds.sub.DataReader Entities. More...

interface	ForDataWriter
	A QosPolicy interface that implements this marker interface applies to org.omg.dds.pub.DataWriter Entities. More...

interface	ForDomainParticipant
	A QosPolicy interface that implements this marker interface applies to org.omg.dds.domain.DomainParticipant Entities. More...

interface	ForDomainParticipantFactory
	A QosPolicy interface that implements this marker interface applies to org.omg.dds.domain.DomainParticipantFactory objects. More...

interface	ForPublisher
	A QosPolicy interface that implements this marker interface applies to org.omg.dds.pub.Publisher Entities. More...

interface	ForSubscriber
	A QosPolicy interface that implements this marker interface applies to org.omg.dds.sub.Subscriber Entities. More...

interface	ForTopic
	A QosPolicy interface that implements this marker interface applies to org.omg.dds.topic.Topic Entities. More...

Public Member Functions
ServiceEnvironment	getEnvironment ()

Detailed Description

This class is the abstract root for all the QoS policies.

It provides the basic mechanism for an application to specify quality of service parameters. All concrete QosPolicy classes derive from this root and include a value whose type depends on the concrete QoS policy.

The type of a QosPolicy value may be atomic, such as an integer or float, or compound (a structure). Compound types are used whenever multiple parameters must be set coherently to define a consistent value for a QosPolicy.

Each org.omg.dds.core.Entity can be configured with a collection of QosPolicy. However, any Entity cannot support any QosPolicy. For instance, a org.omg.dds.domain.DomainParticipant supports different QosPolicy than a org.omg.dds.topic.Topic or a org.omg.dds.pub.Publisher.

QosPolicy can be set when the Entity is created, or modified with the org.omg.dds.core.Entity#setQos(org.omg.dds.core.EntityQos) method. Each QosPolicy in collection list is treated independently from the others. This approach has the advantage of being very extensible. However, there may be cases where several policies are in conflict. Consistency checking is performed each time the policies are modified via the org.omg.dds.core.Entity#setQos(org.omg.dds.core.EntityQos) operation.

When a policy is changed after being set to a given value, it is not required that the new value be applied instantaneously; the Service is allowed to apply it after a transition phase. In addition, some QosPolicy have "immutable" semantics meaning that they can only be specified either at Entity creation time or else prior to calling the org.omg.dds.core.Entity#enable() operation on the Entity.

Objects of this type are immutable.

Properties of QoS Policies

In several cases, for communications to occur properly (or efficiently), a QosPolicy on the publisher side must be compatible with a corresponding policy on the subscriber side. For example, if a org.omg.dds.sub.DataReader requests to receive data reliably while the corresponding org.omg.dds.pub.DataWriter defines a best-effort policy, communication will not happen as requested. To address this issue and maintain the desirable decoupling of publication and subscription as much as possible, the specification for QosPolicy follows the subscriber-requested, publisher-offered pattern. In this pattern, the subscriber side can specify a "requested" value for a particular QosPolicy. The publisher side specifies an "offered" value for that QosPolicy. The Service will then determine whether the value requested by the subscriber side is compatible with what is offered by the publisher side. If the two policies are compatible, then communication will be established. If the two policies are not compatible, the Service will not establish communications between the two org.omg.dds.core.Entity objects and will record this fact by means of the org.omg.dds.core.status.OfferedIncompatibleQosStatus status on the publisher end and org.omg.dds.core.status.RequestedIncompatibleQosStatus status on the subscriber end. The application can detect this fact by means of a listener (e.g. org.omg.dds.sub.DataReaderListener or org.omg.dds.pub.DataWriterListener) or org.omg.dds.core.Conditions.

The QosPolicy objects that need to be set in a compatible manner between the publisher and subscriber ends are indicated by the setting of the "RxO" (Requested/Offered) property:

An "RxO" setting of "Yes" indicates that the policy can be set both at the publishing and subscribing ends and the values must be set in a compatible manner. In this case the compatible values are explicitly defined.
An "RxO" setting of "No" indicates that the policy can be set both at the publishing and subscribing ends but the two settings are independent. That is, all combinations of values are compatible.
An "RxO" setting of "N/A" indicates that the policy can only be specified at either the publishing or the subscribing end, but not at both ends. So compatibility does not apply.

The "changeable" property determines whether the QosPolicy can be changed after the Entity is enabled. In other words, a policy with "changeable" setting of "NO" is considered "immutable" and can only be specified either at org.omg.dds.core.Entity creation time or else prior to calling the org.omg.dds.core.Entity#enable() operation.

Definition at line 118 of file QosPolicy.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.

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

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

Classes

Public Member Functions

Detailed Description

Member Function Documentation

◆ getEnvironment()