|
RTI Connext C API Version 7.3.0
|
APIs to configure compliance with certain standard specifications. More...
Macros | |
| #define | NDDS_CONFIG_XTYPES_COMPLIANCE_MASK_VENDOR |
| XTypes vendor compliance mask. This value is fully aligned with the XTypes specification. More... | |
| #define | NDDS_CONFIG_XTYPES_COMPLIANCE_MASK_DEFAULT |
| Default XTypes compliance mask. More... | |
Typedefs | |
| typedef DDS_UnsignedLong | NDDS_Config_XTypesComplianceMask |
| XTypes compliance mask. More... | |
Enumerations | |
| enum | NDDS_Config_XTypesComplianceMaskBits { NDDS_CONFIG_XTYPES_DHEADER_IN_NON_PRIMITIVE_COLLECTIONS_BIT , NDDS_CONFIG_XTYPES_ENUM_AS_PRIMITIVE_IN_COLLECTIONS_BIT , NDDS_CONFIG_XTYPES_PARAMETER_LENGTH_WITH_PADDING_BIT , NDDS_CONFIG_XTYPES_ENCAPSULATION_OPTIONS_WITH_PADDING_BIT } |
| The bits for the NDDS_Config_XTypesComplianceMask with different aspects of the Extended CDR encoding (XCDR and XCDR2). More... | |
Functions | |
| NDDS_Config_XTypesComplianceMask | NDDS_Config_get_xtypes_compliance_mask (void) |
| Gets the XTypes compliance mask value for the application. More... | |
| void | NDDS_Config_set_xtypes_compliance_mask (NDDS_Config_XTypesComplianceMask mask) |
| Sets the level of compliance of the application with the XTypes specification. More... | |
| DDS_Boolean | NDDS_Config_load_compliance_masks (void) |
| Load the compliance masks from the environment variables. More... | |
APIs to configure compliance with certain standard specifications.
| #define NDDS_CONFIG_XTYPES_COMPLIANCE_MASK_VENDOR |
XTypes vendor compliance mask. This value is fully aligned with the XTypes specification.
The mask sets the following bits:
The HEX value for the mask is: 0x00000009.
| #define NDDS_CONFIG_XTYPES_COMPLIANCE_MASK_DEFAULT |
Default XTypes compliance mask.
The mask sets the following bits:
The HEX value for the mask is: 0x0000000C.
XTypes compliance mask.
The NDDS_Config_XTypesComplianceMask configures different aspects of the Extended CDR encoding (XCDR and XCDR2).
Applications that don't use the exact same XTypes compliance mask may not be interoperable.
By default, data serialization is not fully compliant with Extended CDR encoding due to bugs when implementing the standard. These bugs do not result in breaking functional correctness. They only affect interoperability with other vendors.
You can change the default compliance mask for an application using any of the following mechanisms:
The environment variable will be automatically loaded when a DDS_DomainParticipantFactory is created. If you need to load it before that, use the function NDDS_Config_load_compliance_masks.
The format of the environment variable is an unsigned integer, which can be in HEX notation. For example: 0x00000001.
The default value is NDDS_CONFIG_XTYPES_COMPLIANCE_MASK_DEFAULT.
To be fully compliant with the XTypes specification, set the mask to NDDS_CONFIG_XTYPES_COMPLIANCE_MASK_VENDOR.
The bits for the NDDS_Config_XTypesComplianceMask with different aspects of the Extended CDR encoding (XCDR and XCDR2).
| Enumerator | |
|---|---|
| NDDS_CONFIG_XTYPES_DHEADER_IN_NON_PRIMITIVE_COLLECTIONS_BIT | When this bit is set, the serialization of sequences and arrays with non-primitive members includes a DHEADER. Value: 0x00000001 To be compatible with the XTypes specification, this bit must be set. This bit only applies to XCDR2 encoding. Limitation: For FlatData, the compliant encoding is applied to arrays and sequences of mutable types, but not final types . The serialization of final types containing arrays of non-primitive types in the FlatData language binding is not compliant with Extended CDR encoding version 2 in any case. |
| NDDS_CONFIG_XTYPES_ENUM_AS_PRIMITIVE_IN_COLLECTIONS_BIT | When this bit is set, enums are considered primitive types in collection types. Value: 0x00000002 A DHEADER will not be added to collections of enums if NDDS_CONFIG_XTYPES_DHEADER_IN_NON_PRIMITIVE_COLLECTIONS_BIT is set. To be compatible with the XTypes specification, this bit must be unset. This bit only applies to XCDR2 encoding. |
| NDDS_CONFIG_XTYPES_PARAMETER_LENGTH_WITH_PADDING_BIT | When this bit is set, the length of a member header in a mutable type or an optional member will include padding bytes to a 4-byte boundary. Value: 0x00000004 To be compatible with the XTypes specification, this bit must be unset. This bit only applies to XCDR encoding. |
| NDDS_CONFIG_XTYPES_ENCAPSULATION_OPTIONS_WITH_PADDING_BIT | When this bit is set, RTI Connext will set the padding bits in the options field of the encapsulation header of a serialized payload. Value: 0x00000008 When this bit is set RTI Connext will set the least significant two bits in the second byte of the options field to a value that encodes the number of padding bytes needed after the end of the serialized payload in order to reach the next 4-byte aligned offset. Specifically, the least significant two bits shall be set to binary 00 if no padding bits would be needed and binary 01, 10, or 11 if, respectively, there would be one, two, or three bytes of padding needed. These bits in the options field will be interpreted by a DataReader to determine where the serialized data exactly ended. To be compatible with the XTypes specification, this bit must be set. To be compatible with the following Micro versions this bit must be unset because those versions of Micro did not support padding bits and will discard any data with encapsulations options not set to 0.
This bit applies to both, XCDR and XCDR2 encodings. |
| NDDS_Config_XTypesComplianceMask NDDS_Config_get_xtypes_compliance_mask | ( | void | ) |
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.
| void NDDS_Config_set_xtypes_compliance_mask | ( | NDDS_Config_XTypesComplianceMask | mask | ) |
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.
| mask | <<in>> Compliance mask. |
| DDS_Boolean NDDS_Config_load_compliance_masks | ( | void | ) |
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.