RTI Connext DDS Micro C++ API  Version 4.0.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
DDS_UserDataQosPolicy Struct Reference

Attaches a buffer of opaque data to a DDSEntity which is distributed to other applications as part of the discovery process. More...

#include <dds_c_user_data_qos.h>

List of all members.

Public Attributes

struct DDS_OctetSeq value
 The opaque data to be attached to the DDSEntity.

Detailed Description

Attaches a buffer of opaque data to a DDSEntity which is distributed to other applications as part of the discovery process.

Entity:
DDSDomainParticipant, DDSDataWriter, DDSDataReader
Properties:
RxO = NO
Changeable = NO

Usage

The USER_DATA QoS policy allows an application to attach additional information to DDSEntity objects so that when a remote application discovers them, it can access that information and use it for its own purposes. This information is not interpreted by RTI Connext DDS Micro. Use cases are usually application-to-application identification, authentication, authorization, and encryption.

The user data for a remote entity is received through the discovery process. The received user data can be accessed through the functions for accessing the discovered entity data: DDSDomainParticipant::get_discovered_participant_data, DDSDataWriter::get_matched_subscription_data, and DDSDataReader::get_matched_publication_data operations.

Important: RTI Connext DDS Micro stores the data placed in this policy in pre-allocated pools. You must configure RTI Connext DDS Micro with the maximum size and number of the data sequences that will be stored in policies of this type. These settings are configured in the DDS_DomainParticipantResourceLimitsQosPolicy.


Member Data Documentation

struct DDS_OctetSeq DDS_UserDataQosPolicy::value

The opaque data to be attached to the DDSEntity.

[default] empty (zero length)


RTI Connext DDS Micro C++ API Version 4.0.1 Copyright © Mon Jun 3 2024 Real-Time Innovations, Inc