RTI Connext .NET API (legacy)  Version 6.1.2
DDS::UserDataQosPolicy Class Reference

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

#include <managed_infrastructure.h>

Static Public Member Functions

static System::String ^ get_userdata_qos_policy_name ()
 Stringified human-readable name for DDS::UserDataQosPolicy. More...
 

Public Attributes

ByteSeqvalue
 a sequence of octets More...
 

Detailed Description

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

Entity:
DDS::DomainParticipant, DDS::DataReader, DDS::DataWriter
Properties:
RxO = NO;
Changeable = YES
See also
DDS::DomainParticipant::get_builtin_subscriber

Usage

The purpose of this QoS is to allow the application to attach additional information to the created DDS::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 DDS::DomainParticipant::ignore_participant, DDS::DomainParticipant::ignore_publication, DDS::DomainParticipant::ignore_subscription, and DDS::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 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

◆ value

ByteSeq ^ DDS::UserDataQosPolicy::value

a sequence of octets

[default] empty (zero-length)

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

Referenced by get_userdata_qos_policy_name().