RTI Connext Traditional C++ API  Version 6.0.0
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
DDS_EntityNameQosPolicy Struct Reference

Assigns a name and a role name to a DDSDomainParticipant, DDSPublisher, DDSSubscriber, DDSDataWriter or DDSDataReader. Except for DDSPublisher and DDSSubscriber, these names will be visible during the discovery process and in RTI tools to help you visualize and debug your system. More...

Public Attributes

char * name
 The name of the entity.
 
char * role_name
 The entity role name.
 

Detailed Description

Assigns a name and a role name to a DDSDomainParticipant, DDSPublisher, DDSSubscriber, DDSDataWriter or DDSDataReader. Except for DDSPublisher and DDSSubscriber, these names will be visible during the discovery process and in RTI tools to help you visualize and debug your system.

Entity:
DDSDomainParticipant, DDSSubscriber, DDSPublisher, DDSDataReader, DDSDataWriter
Properties:
RxO = NO;
Changeable = UNTIL ENABLE

Usage

The name and role name can only be 255 characters in length.

The strings must be null-terminated strings allocated with DDS_String_alloc or DDS_String_dup.

If you provide a non-null pointer when getting the QoS, then it should point to valid memory that can be written to, to avoid ungraceful failures.

Member Data Documentation

char* DDS_EntityNameQosPolicy::name

The name of the entity.

[default] null

[range] Null terminated string with length not exceeding 255. It can be null.

char* DDS_EntityNameQosPolicy::role_name

The entity role name.

With Durable Subscriptions this name is used to specify to which Durable Subscription the DDSDataReader belongs.

With Collaborative DataWriters this name is used to specify to which endpoint group the DDSDataWriter belongs.

[range] Null terminated string with length not exceeding 255. It can be null.

[default] null


RTI Connext Traditional C++ API Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc