RTI Connext Java API  Version 5.0.0
UserDataQosPolicy Class Reference

Attaches a buffer of opaque data that is distributed by means of Built-in Topics during discovery. More...

Inheritance diagram for UserDataQosPolicy:

Public Attributes

final ByteSeq value
 a sequence of octets
- Public Attributes inherited from QosPolicy
final QosPolicyId_t id
 The ID of this QoS policy.
final String policy_name
 The name of this QoS policy.

Additional Inherited Members

- Public Member Functions inherited from Struct
abstract boolean equals (Object obj)
abstract int hashCode ()
String toString ()
- Protected Member Functions inherited from Struct
 Struct ()
abstract void pull_from_nativeI (long native_status)
abstract void push_to_nativeI (long native_status)

Detailed Description

Attaches a buffer of opaque data that is distributed by means of Built-in Topics during discovery.

com.rti.dds.domain.DomainParticipant, com.rti.dds.subscription.DataReader, com.rti.dds.publication.DataWriter
RxO = NO;
Changeable = YES
See Also


The purpose of this QoS is to allow the application to attach additional information to the created com.rti.dds.infrastructure.Entity objects, so that when a remote application discovers their existence, it can access that information and use it for its own purposes. This information is not used by RTI Connext.

One possible use of this QoS is to attach security credentials or some other information that can be used by the remote application to authenticate the source.

In combination with operations such as com.rti.dds.domain.DomainParticipant.ignore_participant, com.rti.dds.domain.DomainParticipant.ignore_publication, com.rti.dds.domain.DomainParticipant.ignore_subscription, and com.rti.dds.domain.DomainParticipant.ignore_topic, this QoS policy can assist an application to define and enforce its own security policies.

The use of this QoS is not limited to security; it offers a simple, yet flexible extensibility mechanism.

Important: RTI Connext stores the data placed in this policy in pre-allocated pools. It is therefore necessary to configure RTI Connext with the maximum size of the data that will be stored in policies of this type. This size is configured with com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.participant_user_data_max_length, com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.writer_user_data_max_length, and com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.reader_user_data_max_length.

Member Data Documentation

final ByteSeq value

a sequence of octets

[default] empty (zero-length)

[range] Octet sequence of length [0,max_length]

RTI Connext Java API Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc