org.omg.dds.core.EntityQos< P extends QosPolicy > Interface Template Reference

The Data-Distribution Service (DDS) relies on the use of QoS. More...

Inheritance diagram for org.omg.dds.core.EntityQos< P extends QosPolicy >:

Collaboration diagram for org.omg.dds.core.EntityQos< P extends QosPolicy >:

Public Member Functions
public< POLICY extends P > POLICY	get (Class< POLICY > id)
ServiceEnvironment	getEnvironment ()
PolicyFactory	getPolicyFactory ()
	Provides an instance of org.omg.dds.core.policy.PolicyFactory. More...
EntityQos< P >	withPolicies (P... policy)
	Copy this object and override the values of the given policies. More...
EntityQos< P >	withPolicy (P policy)
	Copy this object and override the value of the given policy. More...

Detailed Description

The Data-Distribution Service (DDS) relies on the use of QoS.

A QoS (Quality of Service) is a set of characteristics that controls some aspect of the behavior of the DDS Service. QoS is comprised of individual QoS policies (objects of type deriving from org.omg.dds.core.policy.QosPolicy).

QoS (i.e., a collection of QosPolicy objects) may be associated with all org.omg.dds.core.Entity objects in the system such as org.omg.dds.topic.Topic, org.omg.dds.pub.DataWriter, org.omg.dds.sub.DataReader, org.omg.dds.pub.Publisher, org.omg.dds.sub.Subscriber, and org.omg.dds.domain.DomainParticipant.

Some QosPolicy values may not be consistent with other ones. When a set of QosPolicy is passed (org.omg.dds.core.Entity#setQos(EntityQos) operations), the set resulting from adding the new policies on top of the previous is checked for consistency. If the resulting QoS is inconsistent, the change of QoS operation fails and the previous values are retained.

Objects of this type are immutable.

Definition at line 49 of file EntityQos.java.

Member Function Documentation

get()

public<POLICY extends P> POLICY org.omg.dds.core.EntityQos< P extends QosPolicy >.get

(

Class< POLICY >

id

)

Returns

a reference to the corresponding policy in this EntityQos.

See also

Map::get(Object)

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.

Implemented in org.omg.dds.core.ServiceEnvironment, org.opensplice.dds.sub.ReflectionDataReader< TYPE, OUT_TYPE >, org.opensplice.dds.core.ModifiableTimeImpl, org.opensplice.dds.pub.ReflectionDataWriter< TYPE >, org.opensplice.dds.core.DurationImpl, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >, org.opensplice.dds.type.TypeSupportImpl< TYPE >, org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl, org.opensplice.dds.topic.SubscriptionBuiltinTopicDataImpl, org.opensplice.dds.topic.TopicBuiltinTopicDataImpl, org.opensplice.dds.domain.DomainParticipantFactoryImpl, org.opensplice.dds.core.QosProviderImpl, org.opensplice.dds.core.status.OfferedIncompatibleQosStatusImpl, org.opensplice.dds.core.status.RequestedIncompatibleQosStatusImpl, org.opensplice.dds.core.InstanceHandleImpl, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, org.opensplice.dds.core.status.LivelinessChangedStatusImpl, org.opensplice.dds.core.status.PublicationMatchedStatusImpl, org.opensplice.dds.core.status.SubscriptionMatchedStatusImpl, org.opensplice.dds.sub.SampleImpl< TYPE >, org.opensplice.dds.core.policy.ShareImpl, org.opensplice.dds.core.status.OfferedDeadlineMissedStatusImpl, org.opensplice.dds.core.status.SampleRejectedStatusImpl, org.opensplice.dds.core.WaitSetImpl, org.opensplice.dds.topic.ParticipantBuiltinTopicDataImpl, org.opensplice.dds.core.status.RequestedDeadlineMissedStatusImpl, org.opensplice.dds.topic.BuiltinTopicKeyImpl, org.opensplice.dds.core.GuardConditionImpl, org.opensplice.dds.core.event.AllDataDisposedEventImpl< TYPE >, org.opensplice.dds.core.policy.QosPolicyCountImpl, org.opensplice.dds.core.status.InconsistentTopicStatusImpl, org.opensplice.dds.core.status.LivelinessLostStatusImpl, org.opensplice.dds.core.status.SampleLostStatusImpl, org.opensplice.dds.core.policy.QosPolicyImpl, org.opensplice.dds.core.status.AllDataDisposedStatusImpl, org.opensplice.dds.core.IllegalArgumentExceptionImpl, org.opensplice.dds.core.InconsistentPolicyExceptionImpl, org.opensplice.dds.core.policy.PolicyFactoryImpl, org.opensplice.dds.core.policy.TypeConsistencyEnforcementImpl, org.opensplice.dds.core.PreconditionNotMetExceptionImpl, org.opensplice.dds.core.AlreadyClosedExceptionImpl, org.opensplice.dds.core.IllegalOperationExceptionImpl, org.opensplice.dds.core.ImmutablePolicyExceptionImpl, org.opensplice.dds.core.NotEnabledExceptionImpl, org.opensplice.dds.core.OutOfResourcesExceptionImpl, org.opensplice.dds.core.DDSExceptionImpl, org.opensplice.dds.core.status.DataAvailableStatusImpl, and org.opensplice.dds.core.status.DataOnReadersStatusImpl.

getPolicyFactory()

PolicyFactory org.omg.dds.core.EntityQos< P extends QosPolicy >.getPolicyFactory

(

)

Provides an instance of org.omg.dds.core.policy.PolicyFactory.

Returns

An instance of org.omg.dds.core.policy.PolicyFactory

Implemented in org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >.

withPolicies()

EntityQos<P> org.omg.dds.core.EntityQos< P extends QosPolicy >.withPolicies

(

P...

policy

)

Copy this object and override the values of the given policies.

Returns

a new object

Exceptions

IllegalArgumentException

if any given policy is not applicable to the concrete type of this EntityQos.

See also

#withPolicy(QosPolicy)

withPolicy()

EntityQos<P> org.omg.dds.core.EntityQos< P extends QosPolicy >.withPolicy

(

P

policy

)

Copy this object and override the value of the given policy.

Returns

a new object

Exceptions

IllegalArgumentException

if the given policy is not applicable to the concrete type of this EntityQos.

See also

withPolicies(QosPolicy...)

---

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

• java5/common/java/code/org/omg/dds/core/EntityQos.java