Built-in Types

RTI Connext provides a set of very simple data types for you to use with the topics in your application.

Modules

Summary: RTI Connext provides a set of very simple data types for you to use with the topics in your application.

The middleware provides four built-in types:

  • String: A payload consisting of a single string of characters. This type has no key.
  • DDS_KeyedString: A payload consisting of a single string of characters and a second string, the key, that identifies the instance to which the sample belongs.
  • DDS_Octets: A payload consisting of an opaque variable-length array of bytes. This type has no key.
  • DDS_KeyedOctets: A payload consisting of an opaque variable-length array of bytes and a string, the key, that identifies the instance to which the sample belongs.

    The String and DDS_KeyedString types are appropriate for simple text-based applications. The DDS_Octets and DDS_KeyedOctets types are appropriate for applications that perform their own custom data serialization, such as legacy applications still in the process of migrating to dds. In most cases, string-based or structured data is preferable to opaque data, because the latter cannot be easily visualized in tools or used with content-based filters (see DDS.ContentFilteredTopic).

    The built-in types are very simple in order to get you up and running as quickly as possible. If you need a structured data type you can define your own type with exactly the fields you need in one of two ways:

  • At compile time, by generating code from an IDL or XML file using the DDSNddsgenModule utility
  • At runtime, by using the DDSDynamicDataModule API

    Managing Memory for Builtin Types

    When a sample is written, the DataWriter serializes it and stores the result in a buffer obtained from a pool of preallocated buffers. In the same way, when a sample is received, the DataReader deserializes it and stores the result in a sample coming from a pool of preallocated samples.

    For builtin types, the maximum size of the buffers/samples and depends on the nature of the application using the builtin type.

    You can configure the maximum size of the builtin types on a per-DataWriter and per-DataReader basis using the DDS.PropertyQosPolicy in DataWriters, DataReaders or Participants.

    The following table lists the supported builtin type properties to configure memory allocation. When the properties are defined in the DomainParticipant, they are applicable to all DataWriters and DataReaders belonging to the DomainParticipant unless they are overwrittem in the DataWriters and DataReaders.

    Builtin Types Allocation Properties
    Property Description
    dds.builtin_type.string.alloc_size Maximum size of the strings published by the DDSStringDataWriter or received the DDSStringDataReader (includes the NULL-terminated character).

    Default: dds.builtin_type.string.max_size if defined. Otherwise, 1024.

    dds.builtin_type.keyed_string.alloc_key_size Maximum size of the keys used by the DDSKeyedStringDataWriter or DDSKeyedStringDataReader (includes the NULL-terminated character).

    Default: dds.builtin_type.keyed_string.max_key_size if defined. Otherwise, 1024.

    dds.builtin_type.keyed_string.alloc_size Maximum size of the strings published by the DDSKeyedStringDataWriter or received by the DDSKeyedStringDataReader (includes the NULL-terminated character).

    Default: dds.builtin_type.keyed_string.max_size if defined. Otherwise, 1024.

    dds.builtin_type.octets.alloc_size Maximum size of the octet sequences published the DDSOctetsDataWriter or received by the DDSOctetsDataReader.

    Default: dds.builtin_type.octets.max_size if defined. Otherwise, 2048.

    dds.builtin_type.keyed_octets.alloc_key_size Maximum size of the key published by the DDSKeyedOctetsDataWriter or received by the DDSKeyedOctetsDataReader (includes the NULL-terminated character).

    Default: dds.builtin_type.keyed_octets.max_key_size if defined. Otherwise, 1024.

    dds.builtin_type.keyed_octets.alloc_size Maximum size of the octets sequences published by a DDSKeyedOctetsDataWriter or received by a DDSKeyedOctetsDataReader.

    Default: dds.builtin_type.keyed_octets.max_size if defined. Otherwise, 2048.

    The previous properties must be set consistently with respect to the corresponding *.max_size properties that set the maximum size of the builtin types in the typecode.

    Typecodes for Builtin Types

    The typecodes associated with the builtin types are generated from the following IDL type definitions:

    module DDS {
         struct String {
             string value;
         };
     
         struct KeyedString {
             string key;
             string value;
         };
     
         struct Octets {
             sequence value;
         };
     
         struct KeyedOctets {
             string key;
             sequence value;
         };
     };
    

    The maximum size of the strings and sequences that will be included in the type code definitions can be configured on a per-DomainParticipant-basis by using the properties in following table.

    Properties for Allocating Size of Builtin Types, per DomainParticipant
    Property Description
    dds.builtin_type.string.max_size Maximum size of the strings published by the StringDataWriters and received by the StringDataReaders belonging to a DomainParticipant (includes the NULL-terminated character).

    Default: 1024.

    dds.builtin_type.keyed_string.max_key_size Maximum size of the keys used by the KeyedStringDataWriters and KeyedStringDataReaders belonging to a DomainParticipant (includes the NULL-terminated character).

    Default: 1024.

    dds.builtin_type.keyed_string.max_size Maximum size of the strings published by the KeyedStringDataWriters and received by the KeyedStringDataReaders belonging to a DomainParticipant using the builtin type (includes the NULL-terminated character).

    Default: 1024

    dds.builtin_type.octets.max_size Maximum size of the octet sequences published by the OctetsDataWriters and received by the OctetsDataReader belonging to a DomainParticipant.

    Default: 2048

    dds.builtin_type.keyed_octets.max_key_size Maximum size of the keys used by the KeyedOctetsStringDataWriters and KeyedOctetsStringDataReaders belonging to a DomainParticipant (includes the NULL-terminated character).

    Default: 1024.

    dds.builtin_type.keyed_octets.max_size Maximum size of the octet sequences published by the KeyedOctetsDataWriters and received by the KeyedOctetsDataReaders belonging to a DomainParticipant.

    Default: 2048

    For more information about the built-in types, including how to control memory usage and maximum lengths, please see the "Data Types and DDS Data Samples" chapter in the User's Manual .