RTI Connext Traditional C++ API Version 7.3.0

APIs to configure the XTypes compliance mask. More...

Static Public Member Functions

static NDDS_Config_XTypesComplianceMask get_xtypes_mask ()
 Gets the XTypes compliance mask value for the application. More...
 
static void set_xtypes_mask (NDDS_Config_XTypesComplianceMask mask)
 Sets the level of compliance of the application with the XTypes specification. More...
 
static void load_compliance_masks ()
 Load the compliance masks from the environment variables. More...
 

Detailed Description

APIs to configure the XTypes compliance mask.

Member Function Documentation

◆ get_xtypes_mask()

static NDDS_Config_XTypesComplianceMask NDDSConfigCompliance::get_xtypes_mask ( )
static

Gets the XTypes compliance mask value for the application.

The NDDS_Config_XTypesComplianceMask configures different aspects of the Extended CDR encoding (XCDR and XCDR2) for the application.

Returns
The NDDS_Config_XTypesComplianceMask value.
See also
NDDS_Config_XTypesComplianceMask
NDDSConfigCompliance::get_xtypes_mask
NDDSConfigCompliance::load_compliance_masks

◆ set_xtypes_mask()

static void NDDSConfigCompliance::set_xtypes_mask ( NDDS_Config_XTypesComplianceMask  mask)
static

Sets the level of compliance of the application with the XTypes specification.

The NDDS_Config_XTypesComplianceMask configures different aspects of the Extended CDR encoding (XCDR and XCDR2) for the application.

Once you call this function the value of the mask will apply to all the DomainParticipants created after the call. It won't apply to DomainParticipants created before the call.

In general, applications should only set the mask once, before executing any other RTI Connext API. The mask can also be set using the environment variable NDDS_XTYPES_COMPLIANCE_MASK.

Parameters
mask<<in>> Compliance mask.
See also
NDDS_Config_XTypesComplianceMask
NDDSConfigCompliance::get_xtypes_mask
NDDSConfigCompliance::load_compliance_masks

◆ load_compliance_masks()

static void NDDSConfigCompliance::load_compliance_masks ( )
static

Load the compliance masks from the environment variables.

The only compliance mask loaded by this function is the XTypes compliance mask, which can be set using the environment variable NDDS_XTYPES_COMPLIANCE_MASK.

See also
NDDS_Config_XTypesComplianceMask
NDDSConfigCompliance::set_xtypes_mask
NDDSConfigCompliance::get_xtypes_mask