RTI Connext Java API  Version 5.0.0
PropertyQosPolicy Class Reference

Stores name/value(string) pairs that can be used to configure certain parameters of RTI Connext that are not exposed through formal QoS policies. Can also be used to store and propagate application-specific name/value pairs that can be retrieved by user code during discovery. More...

Inheritance diagram for PropertyQosPolicy:
QosPolicy

Public Attributes

final PropertySeq value
 Sequence of properties.
 
- 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

Stores name/value(string) pairs that can be used to configure certain parameters of RTI Connext that are not exposed through formal QoS policies. Can also be used to store and propagate application-specific name/value pairs that can be retrieved by user code during discovery.

Entity:
com.rti.dds.domain.DomainParticipant com.rti.dds.subscription.DataReader com.rti.dds.publication.DataWriter
Properties:
RxO = N/A;
Changeable = YES
See Also
com.rti.dds.domain.DomainParticipant.get_builtin_subscriber

Usage

The PROPERTY QoS policy can be used to associate a set of properties in the form of (name,value) pairs with a com.rti.dds.subscription.DataReader, com.rti.dds.publication.DataWriter, or com.rti.dds.domain.DomainParticipant. This is similar to the com.rti.dds.infrastructure.UserDataQosPolicy, except this policy uses (name, value) pairs, and you can select whether or not a particular pair should be propagated (included in the builtin topic).

This QoS policy may be used to configure:

In addition, you may add your own name/value pairs to the Property QoS policy of an Entity. Via this QoS policy, you can direct RTI Connext to propagate these name/value pairs with the discovery information for the Entity. Applications that discover the Entity can then access the user-specific name/value pairs in the discovery information of the remote Entity. This allows you to add meta-information about an Entity for application-specific use, for example, authentication/authorization certificates (which can also be done using the com.rti.dds.infrastructure.UserDataQosPolicy or com.rti.dds.infrastructure.GroupDataQosPolicy).

Reasons for Using the PropertyQosPolicy

  • Supports dynamic loading of extension transports (such as RTI Secure WAN Transport)
  • Supports multiple instances of the builtin transports
  • Allows full pluggable transport configuration for non-C/C++ language bindings (Java, .NET, etc.)
  • Avoids the process of creating entities disabled, changing their QoS settings, then enabling them
  • Allows selection of clock

Some of the RTI Connext capabilities configurable via the Property QoS policy can also be configured in code via APIs. However, the Property QoS policy allows you to configure those parameters via XML files. In addition, some of the configuration APIs will only work if the Entity was created in a disabled state and then enabled after the configuration change was applied. By configuring those parameters using the Property QoS policy during entity creation, you avoid the additional work of first creating a disabled entity and then enabling it afterwards.

There are helper functions to facilitate working with properties, see the PROPERTY page.

Member Data Documentation

final PropertySeq value
Initial value:
=
new PropertySeq()

Sequence of properties.

[default] An empty list.


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