RTI Connext C# API Version 7.7.0
Rti.Config.Compliance Class Reference

This class contains methods to configure the compliance masks. More...

Public Types

enum  XTypesMask : uint {
  DHeaderInNonPrimitiveCollections ,
  EnumAsPrimitiveInCollections ,
  ParameterLengthWithPadding ,
  EncapsulationOptionsWithPadding ,
  AcceptUnknownEnumValue ,
  AcceptUnknownDiscriminator ,
  SelectDefaultDiscriminator ,
  SentinelInEmptyUnion ,
  InitializeDiscriminatorToDefault ,
  JavaKeyHash750 ,
  PythonInt8Connext730 ,
  MustUnderstandInKeyAndDiscriminator ,
  Vendor ,
  Default
}
 This class configures different aspects of the Extended CDR encoding (XCDR and XCDR2). More...
 

Static Public Member Functions

static XTypesMask GetXTypesMask ()
 Gets the XTypes compliance mask value for the application. More...
 
static void SetXTypesMask (XTypesMask mask)
 Sets the level of compliance of the application with the XTypes specification. More...
 
static void loadComplianceMasks ()
 Load the compliance masks from the environment variables. More...
 

Detailed Description

This class contains methods to configure the compliance masks.

Member Enumeration Documentation

◆ XTypesMask

This class configures different aspects of the Extended CDR encoding (XCDR and XCDR2).

Enumerator
DHeaderInNonPrimitiveCollections 

Serialization of sequences and arrays with non-primitive members includes a DHEADER.

EnumAsPrimitiveInCollections 

Enums are considered primitive types in collection types.

ParameterLengthWithPadding 

The length of a member header in a mutable type or an optional member will include padding bytes to a 4-byte boundary.

EncapsulationOptionsWithPadding 

The padding bits will be set in the options field of the encapsulation header of a serialized payload.

AcceptUnknownEnumValue 

Samples containing an unknown enumerator can be successfully deserialized to the default enumeration value.

AcceptUnknownDiscriminator 

Samples containing an unknown discriminator can be successfully deserialized, and the sample won't be dropped.

SelectDefaultDiscriminator 

Samples containing an unknown discriminator will be assigned the default discriminator value; if the bit is not set, the sample will preserve the discriminator value.

SentinelInEmptyUnion 

Samples of a mutable union that contain an unknown discriminator will be serialized with a 4-byte sentinel value.

InitializeDiscriminatorToDefault 

Unions discriminators will be initialized to the default value of the discriminator type.

JavaKeyHash750 

KeyHash calculation for a Java instance will match the one produced by the Java API in Connext 7.5.0 and earlier versions.

PythonInt8Connext730 

Interoperate with Connext 7.3.0 Python applications that published or subscribed to types with int8 members.

MustUnderstandInKeyAndDiscriminator 

When this bit is set, the parameter id for members that are part of the key, or for the discriminator of a union, will have the MUST_UNDERSTAND bit set when serialized using XCDR2.

Vendor 

This mask configures compliance with the OMG XTypes specification.

Default 

Default XTypes compliance mask.

Member Function Documentation

◆ GetXTypesMask()

static XTypesMask Rti.Config.Compliance.GetXTypesMask ( )
static

Gets the XTypes compliance mask value for the application.

◆ SetXTypesMask()

static void Rti.Config.Compliance.SetXTypesMask ( XTypesMask  mask)
static

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

◆ loadComplianceMasks()

static void Rti.Config.Compliance.loadComplianceMasks ( )
static

Load the compliance masks from the environment variables.