RTI Connext C API  Version 5.3.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
DDS_EntityNameQosPolicy Struct Reference

Assigns a name and a role name to a DDS_DomainParticipant, DDS_Publisher, DDS_Subscriber, DDS_DataWriter or DDS_DataReader. Except for DDS_Publisher and DDS_Subscriber, these names will be visible during the discovery process and in RTI tools to help you visualize and debug your system. More...

Data Fields

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 DDS_DomainParticipant, DDS_Publisher, DDS_Subscriber, DDS_DataWriter or DDS_DataReader. Except for DDS_Publisher and DDS_Subscriber, these names will be visible during the discovery process and in RTI tools to help you visualize and debug your system.

Entity:
DDS_DomainParticipant, DDS_Subscriber, DDS_Publisher, DDS_DataReader, DDS_DataWriter
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.

Field 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 DDS_DataReader belongs.

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

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

[default] null


RTI Connext C API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc