org.omg.dds.core.policy.TopicData Interface Reference

User data not known by the middleware, but distributed by means of built-in topics. More...

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

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

Public Member Functions
ServiceEnvironment	getEnvironment ()
byte []	getValue ()
	Get a copy of the data. More...
TopicData	withValue (byte value[], int offset, int length)
	Copy this policy and override the value of the property. More...

Detailed Description

User data not known by the middleware, but distributed by means of built-in topics.

The default value is an empty (zero-sized) sequence.

Concerns: org.omg.dds.topic.Topic

RxO: No

Changeable: Yes

The purpose of this QoS is to allow the application to attach additional information to the created org.omg.dds.topic.Topics such that when a remote application discovers their existence it can examine the information and use it in an application-defined way. In combination with the listeners on the org.omg.dds.sub.DataReader and org.omg.dds.pub.DataWriter as well as by means of operations such as org.omg.dds.domain.DomainParticipant#ignoreTopic(org.omg.dds.core.InstanceHandle), these QoS can assist an application to extend the provided QoS.

Definition at line 42 of file TopicData.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.

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.

getValue()

byte [] org.omg.dds.core.policy.TopicData.getValue

(

)

Get a copy of the data.

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

withValue()

TopicData org.omg.dds.core.policy.TopicData.withValue	(	byte	value[],
		int	offset,
		int	length
	)

Copy this policy and override the value of the property.

Parameters

value	A sequence of bytes that holds the application topic data. By default, the sequence has length 0.
offset	Not used can have any int value.
length	Not used can have any int value.

Returns

a new policy

---

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

• java5/common/java/code/org/omg/dds/core/policy/TopicData.java