DDS_UserDataQosPolicy Struct Reference
[USER_DATA]

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

List of all members.

Public Attributes
struct DDS_OctetSeq	value
	a sequence of octets

---

Detailed Description

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

Entity:

DDSDomainParticipant, DDSDataReader, DDSDataWriter

Properties:

RxO = NO;
Changeable = YES

See also:

DDSDomainParticipant::get_builtin_subscriber

Usage

The purpose of this QoS is to allow the application to attach additional information to the created DDSEntity 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 Data Distribution Service.

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 DDSDomainParticipant::ignore_participant, DDSDomainParticipant::ignore_publication, DDSDomainParticipant::ignore_subscription, and DDSDomainParticipant::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 Data Distribution Service stores the data placed in this policy in pre-allocated pools. It is therefore necessary to configure RTI Data Distribution Service with the maximum size of the data that will be stored in policies of this type. This size is configured with DDS_DomainParticipantResourceLimitsQosPolicy::participant_user_data_max_length, DDS_DomainParticipantResourceLimitsQosPolicy::writer_user_data_max_length, and DDS_DomainParticipantResourceLimitsQosPolicy::reader_user_data_max_length.

---

Member Data Documentation

struct DDS_OctetSeq DDS_UserDataQosPolicy::value [read]

a sequence of octets

[default] empty (zero-length)

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