RTI Connext DDS Micro C API  Version 2.4.14
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
DDS_EntityFactoryQosPolicy Struct Reference

<<cert>> A QoS policy for all DDS_Entity types that can act as factories for one or more other DDS_Entity types. More...

#include <dds_c_infrastructure.h>

Data Fields

DDS_Boolean autoenable_created_entities
 Specifies whether the entity acting as a factory automatically enables the instances it creates.

Detailed Description

<<cert>> A QoS policy for all DDS_Entity types that can act as factories for one or more other DDS_Entity types.

Entity:
DDS_DomainParticipantFactory, DDS_DomainParticipant, DDS_Publisher, DDS_Subscriber
Properties:
RxO = NO
Changeable = YES for DDS_DomainParticipantFactory, UNTIL ENABLE for DDS_DomainParticipant, DDS_Publisher and DDS_Subscriber.

Usage

This policy controls the behavior of the DDS_Entity as a factory for other entities.

This policy is mutable. A change in the policy affects only the entities created after the change; not the previously created entities.

The setting of autoenable_created_entities to DDS_BOOLEAN_TRUE indicates that the factory create_<entity> operation will automatically invoke the DDS_Entity_enable operation each time a new DDS_Entity is created. Therefore, the DDS_Entity returned by create_<entity> will already be enabled. A setting of DDS_BOOLEAN_FALSE indicates that the DDS_Entity will not be automatically enabled. The application will need to enable it explicitly by means of DDS_Entity_enable operation.

The default setting of autoenable_created_entities = DDS_BOOLEAN_TRUE means that, by default, it is not necessary to explicitly call DDS_Entity_enable on newly created entities.


Field Documentation

DDS_Boolean DDS_EntityFactoryQosPolicy::autoenable_created_entities

Specifies whether the entity acting as a factory automatically enables the instances it creates.

If DDS_BOOLEAN_TRUE, the factory will automatically enable each created entity. Otherwise, it will not.

[default] DDS_BOOLEAN_TRUE


RTI Connext DDS Micro C API Version 2.4.14 Copyright © Mon Apr 12 2021 Real-Time Innovations, Inc