List of Properties
com.rti.serv
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Pattern value |
|
Description |
The prefix name of the security plugin suite that will be loaded by Connext DDS. |
Related to these features |
DDS Secure |
secure
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Pattern value |
|
Description |
Must be set to the security plugin suite creation function that is implemented by the library. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Pattern value |
|
Description |
Must be set to the security plugin suite creation function implemented by the library. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
The time interval (in seconds) at which the Security Plugins check for changes in mutable configuration files. If any valid changes have occurred, the Security Plugins will apply the new configuration. 0 indicates no polling at all. By default, polling is enabled, consuming resources even when there are no files to track. See the “Design Considerations” chapter in RTI Security Plugins User’s Manual for details. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Pattern value |
|
Description |
Must be set to the dynamic library that implements the security plugin suite. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
The value for this property can be set to the location (full path and filename) of a license file. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
The value for this property can be set to the content of a license file. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
A semicolon-separated list of dynamic libraries that each implement an OpenSSL engine. Each engine may implement a different set of security functions. For example, one engine may implement certificate management, while another engine may implement cryptographic operations. If the authentication.keyform property value is engine, then the private key must be successfully loaded by exactly one of the engines in this list. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
DDS Secure |
access_control
com.rti.serv.secure.access_control.alternative_permissions_authority_files |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
A comma-separated list of alternative Permissions CA certificates. |
Related to these features |
DDS Secure |
com.rti.serv.secure.access_control.use_530_logging_protection |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
How to set the value of <metadata_protection_kind> for the Builtin Logging Topic. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
How to determine a match between a DataWriter’s or DataReader’s partitions and an ‘allowed partitions’ condition in a Permissions Document. |
Related to these features |
DDS Secure |
com.rti.serv.secure.access_control.use_530_permissions_rules_precedence |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
How to deal with conflicting allow/deny rules in a Permissions Document when checking if a topic or endpoint may exist. |
Related to these features |
DDS Secure |
com.rti.serv.secure.access_control.use_610_permissions_rules_precedence |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
How to deal with conflicting allow/deny rules in a Permissions Document when checking if a DomainParticipant may exist. |
Related to these features |
DDS Secure |
authentication
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
A comma-separated list of alternative Identity CA certificates. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
mutable |
Default Value |
|
Pattern value |
|
Description |
This Certificate Revocation List keeps track of untrusted X.509 certificates. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Configures whether to enable custom cryptographic algorithms for the Authentication plugin. When enabled (not by default) the Security Plugins will enable additional digital signature and key establishment algorithms that are not part of the DDS Security specification (EDDSA+ED25519+SHA512, EDDSA+ED448+SHAKE256, ECDHE-CEUM+X25519, ECDHE-CEUM+X448). Currently only supported in combination with OpenSSL: this property will have no effect when used in combination with wolfSSL. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Configures whether to set custom crypto library (e.g., OpenSSL) allocators. When enabled (not the default) the Security Plugins will configure custom allocator functions (alloc, realloc, free) to the loaded crypto library with the goal of reducing memory fragmentation at the cost of a minimum performance impact. This is currently only supported in combination with OpenSSL. This property is only effective the first time a DomainParticipant loads the Security Plugins within the same process: subsequent DomainParticipant creations will ignore this property and leave the existing configuration unchanged. Moreover, this property is only effective if no allocation has been done with the crypto library builtin allocators before the Security Plugins have been loaded, otherwise a warning will be logged and no change will be made. Important: since the allocator functions live within the Security Plugins library, your application must not make any calls to the crypto library once the Security Plugins have been unloaded from memory. |
Related to these features |
DDS Secure |
com.rti.serv.secure.authentication.enable_discovery_subject_name_propagation |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
If this property is true, the Subject Name of the local DomainParticipant’s Identity Certificate will be propagated during discovery |
Related to these features |
DDS Secure |
com.rti.serv.secure.authentication.key_establishment_algorithm |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
The algorithm used to establish a shared secret during authentication. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
The format of the private key specified by dds.sec.auth.private_key. If the value is engine, then the openssl_engine property must be set, and the private key must be successfully loaded by exactly one of the engines in that list. |
Related to these features |
DDS Secure |
com.rti.serv.secure.authentication.participant_discovery_protection_key |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
Sets the static HMAC key used to compute participant discovery signatures. |
Related to these features |
DDS Secure |
The property has been deprecated in version |
7.2.0 |
com.rti.serv.secure.authentication.propagate_simplified_identity_certificate |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Indicates whether the identity certificate should be simplified |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Configures whether to use RSA PSS padding or standard RSA padding during authentication |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
The algorithm used to establish a shared secret during authentication. This property is deprecated. Instead, use authentication.key_establishment_algorithm. |
Related to these features |
DDS Secure |
The property has been deprecated in version |
7.0.0 |
cryptography
com.rti.serv.secure.cryptography.enable_additional_authenticated_data |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Enable Additional Authenticated Data for encode operations that support it. Currently only applicable to RTPS protection, where it is used to protect the RTPS Header and RTPS Header Extension Submessage if present. Must be set to true if using RTPS protection in combination with RTPS 2.5 Header Extension. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
The algorithm used for encrypting and decrypting data and metadata. This property is deprecated. Use dds.sec.crypto.symmetric_cipher_algorithm instead. |
Related to these features |
DDS Secure |
The property has been deprecated in version |
7.3.0 |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned long long |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
The number of message blocks that can be encrypted with the same key material. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
The maximum number of receiver-specific Message Authentication Codes (MACs) that are appended to an encoded result. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
Sets the static HMAC key used to compute message signatures. This property is applied when hmac_only.enabled is false. |
Related to these features |
DDS Secure |
The property has been deprecated in version |
7.2.0 |
com.rti.serv.secure.cryptography.share_key_for_metadata_and_data_protection |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Indicator of whether the metadata and data encoding operations share the same key material or use different keys. |
Related to these features |
DDS Secure |
hmac_only
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Enables or disables the HMAC-only mode. |
Related to these features |
DDS Secure |
The property has been deprecated in version |
7.1.0 |
cryptography
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
Sets the static HMAC key used to compute message signatures. |
Related to these features |
DDS Secure |
com.rti.serv.secure.hmac_only.cryptography.max_blocks_per_session |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
For signing RTPS messages, HMAC-only mode uses a key derived from the HMAC key and a sessionId that is serialized as part of the signed RTPS message representation. |
Related to these features |
DDS Secure |
logging
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
The logging verbosity level. |
Related to these features |
DDS Secure |
The property has been deprecated by |
com.rti.serv.secure.logging.verbosity |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
mask |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
The mask to determine the logging mode(s). |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
The logging verbosity level |
Related to these features |
DDS Secure |
security_topic
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
QoS Library and QoS profile used to create logging-related entities (Publisher, Topic and DataWriter). |
Related to these features |
DDS Secure |
security_topic.queue
com.rti.serv.secure.logging.security_topic.queue.message_count_max |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
Maximum number of log messages in the logging queue. |
Related to these features |
DDS Secure |
com.rti.serv.secure.logging.security_topic.queue.message_size_max |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
Maximum serialized size of a log message in the logging queue. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
Size of the logging thread queue, in bytes. |
Related to these features |
DDS Secure |
security_topic.thread
com.rti.serv.secure.logging.security_topic.thread.message_threshold |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
Number of bytes to preallocate for the logging message string in the logging thread, beyond which dynamic allocation will occur. |
Related to these features |
DDS Secure |
com.rti.serv.secure.logging.security_topic.thread.plugin_method_threshold |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
Number of bytes to preallocate for the plugin method string in the logging thread, beyond which dynamic allocation will occur. |
Related to these features |
DDS Secure |
dds.builtin_type
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Register automatically the built-in types when a DomainParticipant is created. |
Related to these features |
Builtin Type |
keyed_octets
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the key published by the DataWriter or received by the DataReader (includes the NULL-terminated character). |
Related to these features |
Builtin Type |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the octet sequences published by the DataWriter or DataReader. |
Related to these features |
Builtin Type |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the key published by the DataWriter and received by the DataReaders belonging to the DomainParticipant (includes the NULL-terminated character). |
Related to these features |
Builtin Type |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the octet sequences published by the DataWriters and DataReaders belonging to a DomainParticipant. |
Related to these features |
Builtin Type |
keyed_string
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the keys used by the DataWriter or DataReader (includes the NULL-terminated character). |
Related to these features |
Builtin Type |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the strings published by the DataWriter or received by the DataReader (includes the NULL-terminated character). |
Related to these features |
Builtin Type |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the keys used by the DataWriters and DataReaders belonging to a DomainParticipant (includes the NULL-terminated character). |
Related to these features |
Builtin Type |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the strings published by the DataWriters and received by the DataReaders belonging to a DomainParticipant using the built-in type (includes the NULL-terminated character). |
Related to these features |
Builtin Type |
octets
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the octet sequences published by the DataWriter or DataReader. |
Related to these features |
Builtin Type |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the octet sequences published by the DataWriters and DataReaders belonging to a DomainParticipant. |
Related to these features |
Builtin Type |
string
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the strings published by the DataWriter or received by the DataReader (includes the NULL-terminated character). |
Related to these features |
Builtin Type |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size of the strings published by the DataWriters and received by the DataReaders belonging to a DomainParticipant (includes the NULL-terminated character). |
Related to these features |
Builtin Type |
dds.clock
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Comma-delimited list of clocks to use for the external clock, in the order of preference. |
Related to these features |
Clock |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Comma-delimited list of clocks to use for the internal clock, in the order of preference. |
Related to these features |
Clock |
dds.data_reader
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Allow accepting invalid samples in a batch at the DataReader. |
Related to these features |
Queue Memory Management |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
The DataReader must attach to the SharedSubscriber that contains the SharedReaderQueue. |
Related to these features |
Other |
history.memory_manager.fast_pool
dds.data_reader.history.memory_manager.fast_pool.pool_buffer_max_size |
|
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Controls the memory allocation for serialization. |
Related to these features |
Queue Memory Management |
history.memory_manager.java_stream
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Defines the minimum size of the buffer used for the serialized data. |
Related to these features |
Queue Memory Management |
dds.data_reader.history.memory_manager.java_stream.trim_to_size |
|
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
A Boolean value that controls the growth of the deserialization buffer. |
Related to these features |
Queue Memory Management |
protocol
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Achieve backward compatibility sending ‘Large Data’ between RTI Data Distribution Service 4.4d and older Releases. |
Related to these features |
Reliability |
reliability
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Delegates the reliability task to a separate service. |
Related to these features |
Reliability |
state
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Controls how often the DataReader state is stored into the database. |
Related to these features |
Durability |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Enables durable DataReader state. |
Related to these features |
Durability |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Indicates if the persisted DataReader state must be restored or not once the DataReader is restarted. |
Related to these features |
Durability |
odbc
May be set in |
DataReader |
Applies to |
DataReader |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Indicates which ODBC driver to load. |
Related to these features |
Durability |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
string |
Pattern value |
|
Description |
The ODBC DSN (Data Source Name) associated with the database where the DataReader state must be persisted. |
Related to these features |
Durability |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
string |
Pattern value |
|
Description |
Configures the password used to connect to the database. |
Related to these features |
Durability |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
string |
Pattern value |
|
Description |
Configures the username used to connect to the database. |
Related to these features |
Durability |
persistence_service
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Indicates how many of the most recent historical samples the persisted DataReader wants to receive upon start-up. |
Related to these features |
Durability |
type_support
May be set in |
DataReader |
Applies to |
DataReader |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Configures the IDL wire string encoding. |
Related to these features |
Type System |
dds.data_writer
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Enables Turbo Mode and adjusts the batch max_data_bytes based on how frequently the DataWriter writes data. |
Related to these features |
Batching |
auto_throttle
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Enables automatic throttling in the DataWriter. |
Related to these features |
Reliability |
cryptography
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Simulate tainted data. Connext DDS will modify one byte of encoded data after the final layer of GMAC or GCM is computed. This property can be used for testing validation of the GMAC hash. Tainting of encoded payloads requires running on a little-endian machine. Tainting is not supported when key_revision_max_history_depth > 0, when enable_additional_authenticated_data is TRUE, or when header extension is enabled. |
Related to these features |
DDS Secure |
history
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
The basis of the key material used to encrypt the PRSTDataWriter’s key material. |
Related to these features |
Durability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Must be set to ‘dds.data_writer.history.odbc_plugin.builtin’ to enable durable writer history in the DataWriter. |
Related to these features |
Durability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
The DataWriter’s behavior can be changed to purge DDS samples after they have been acknowledged by all the active/matching DataReaders. |
Related to these features |
Durability |
dds.data_writer.history.source_timestamp_based_autopurge_instances_delay |
|
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
The purging of the unregistered instances can be done based on the unregistered sample source timestamp or the time when the unregistered sample was added to the DataWriter queue. |
Related to these features |
Durability |
memory_manager.fast_pool
dds.data_writer.history.memory_manager.fast_pool.pool_buffer_max_size |
|
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Controls the memory allocation for the serialized sample. |
Related to these features |
Queue Memory Management |
memory_manager.java_stream
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Defines the minimum size of the buffer that will be used to serialize DDS samples. |
Related to these features |
Queue Memory Management |
dds.data_writer.history.memory_manager.java_stream.trim_to_size |
|
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
A boolean value that controls the growth of the serialization buffer. |
Related to these features |
Queue Memory Management |
odbc_plugin.builtin
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Tells Connext DDS which ODBC driver to load. |
Related to these features |
Durability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
string |
Pattern value |
|
Description |
The ODBC DSN (Data Source Name) associated with the database where the writer history must be persisted. |
Related to these features |
Durability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Determines how much state will be kept in memory by the ODBC writer history in order to avoid accessing the database. |
Related to these features |
Durability |
dds.data_writer.history.odbc_plugin.builtin.instance_cache_init_size |
|
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
integer |
Min-Max value |
|
Description |
Configures the resource limits associated with the ODBC writer history caches. |
Related to these features |
Durability |
dds.data_writer.history.odbc_plugin.builtin.instance_cache_max_size |
|
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Configures the resource limits associated with the ODBC writer history caches. |
Related to these features |
Durability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
string |
Pattern value |
|
Description |
Configures the password used to connect to the database. |
Related to these features |
Durability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Indicates whether or not the persisted writer history must be restored once the DataWriter is restarted. |
Related to these features |
Durability |
dds.data_writer.history.odbc_plugin.builtin.sample_cache_init_size |
|
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Configures the resource limits associated with the ODBC writer history caches. |
Related to these features |
Durability |
dds.data_writer.history.odbc_plugin.builtin.sample_cache_max_size |
|
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Configure the resource limits associated with the ODBC writer history caches. |
Related to these features |
Durability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Creates a single connection per DSN that will be shared across DataWriters within the same Publisher. |
Related to these features |
Durability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
string |
Pattern value |
|
Description |
Configures the username used to connect to the database. |
Related to these features |
Durability |
protocol
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents piggyback HBs from being sent with repair samples |
Related to these features |
Reliability |
The property has been promoted to |
<datawriter_qos><protocol><rtps_reliable_writer><disable_repair_piggyback_heartbeat> |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Support for Periodic heartbeats (HBs) over multicast. |
Related to these features |
Reliability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Support for periodic heartbeats (HBs) over multicast. |
Related to these features |
Reliability |
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Achieve backward compatibility sending ‘Large Data’ between RTI Data Distribution Service 4.4d and older Releases. |
Related to these features |
Reliability |
reliability
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Delegates the reliability task to a separate service. |
Related to these features |
Reliability |
type_support
May be set in |
DataWriter |
Applies to |
DataWriter |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Configures the IDL wire string encoding. |
Related to these features |
Type System |
dds.discovery.endpoint
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
String indicating the prefix name of the plugin that will be loaded by Connext DDS. |
Related to these features |
Discovery |
lbediscovery
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The name of the discovery configuration file. |
Related to these features |
Discovery |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The name of the function that will be called by Connext DDS to create an instance of the LBED plugin. |
Related to these features |
Discovery |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The name of the dynamic library that contains the LBED plugin implementation. |
Related to these features |
Discovery |
dds.discovery.endpoint.lbediscovery.property_validation_action |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Discovery |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
The verbosity for the plugin, for debugging purposes. |
Related to these features |
Discovery |
dds.discovery.participant
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
String indicating the prefix name of the plugin that will be loaded by Connext DDS. |
Related to these features |
Discovery |
lbpdiscovery
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The name of the discovery configuration file. |
Related to these features |
Discovery |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The name of the function that will be called by Connext DDS to create an instance of the LBPD plugin. |
Related to these features |
Discovery |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The name of the dynamic library that contains the LBPD plugin implementation. |
Related to these features |
Discovery |
dds.discovery.participant.lbpdiscovery.property_validation_action |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Discovery |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
The verbosity for the plugin, for debugging purposes. |
Related to these features |
Discovery |
dds.domain_participant
dds.domain_participant.asynchronous_publisher_thread_destruction_timeout |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Related to these features |
Flow Controller |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A string defining the Domain Tag the DomainParticipant will propagate through Participant Discovery. |
Related to these features |
Discovery |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Select the character encoding for filtering |
Related to these features |
Filtering |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Select Unicode normalization for filter evaluation |
Related to these features |
Filtering |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
A sequence of multicast/unicast settings used to configure the addresses associated with a channel. |
Related to these features |
Discovery |
dds.domain_participant.network_interface_event_notification_delay |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Delays the DomainParticipant announcements that include a new interface for the number of milliseconds in the value of the property. |
Related to these features |
Discovery |
auto_throttle
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Configures the DomainParticipant to gather internal measurements (during DomainParticipant creation) that are required for the Auto Throttle feature. |
Related to these features |
Reliability |
dds.flow_controller.token_bucket.<flow_controller_name>
dds.flow_controller.token_bucket.<flow_controller_name>.scheduling_policy |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Specifies the scheduling policy to be used. |
Related to these features |
Flow Controller |
token_bucket
dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.bytes_per_token |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum number of bytes allowed to send for each token available. |
Related to these features |
Flow Controller |
dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.max_tokens |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum number of tokens than can accumulate in the token bucket. |
Related to these features |
Flow Controller |
dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.tokens_added_per_period |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Number of tokens added to the token bucket per specified period. |
Related to these features |
Flow Controller |
dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.tokens_leaked_per_period |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Number of tokens removed from the token bucket per specified period. |
Related to these features |
Flow Controller |
period
dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.period.nanosec |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Period for adding tokens to and removing tokens from the bucket in nanoseconds. |
Related to these features |
Flow Controller |
dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.period.sec |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Period for adding tokens to and removing tokens from the bucket in seconds. |
Related to these features |
Flow Controller |
dds.license
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Pattern value |
|
Description |
Sets the path to the license file |
Related to these features |
License |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Sets the contents of the license. |
Related to these features |
License |
dds.participant
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Enables backtrace printing when handling SIGSEGV signals. |
Related to these features |
Logging |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Other |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Accept RTPS messages with wrong alignment incorrectly. |
Related to these features |
Type System |
builtin_data_writer.protocol
dds.participant.builtin_data_writer.protocol.disable_repair_piggyback_heartbeat |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents piggyback HBs from being sent with repair samples for builtin discovery topics |
Related to these features |
Reliability |
The property has been promoted to |
<domain_participant_qos><discovery_config><publication_writer><disable_repair_piggyback_heartbeat> |
discovery_config
dds.participant.discovery_config.force_endpoint_announcement_on_ip_mobility_event |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Forces the sending of endpoint discovery announcements when there is an IP mobility event. |
Related to these features |
Discovery |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Enables logging a warning when an SPDP message is received by an SPDP2 participant or vice-versa. |
Related to these features |
Discovery |
dds.participant.discovery_config.use_stateless_participant_discovery_reader |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
If TRUE, makes Simple Participant Discovery robust against Sequence Number Attacks by switching the local Simple Participant Discovery DataReader’s mode to pure stateless. |
Related to these features |
Discovery |
inter_participant_data_reader.protocol
dds.participant.inter_participant_data_reader.protocol.disable_preemptive_nack |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Disable preemptive Heartbeats and NACKs. |
Related to these features |
Discovery |
inter_participant_data_writer.protocol
dds.participant.inter_participant_data_writer.protocol.disable_preemptive_heartbeat |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Disable preemptive Heartbeats and NACKs. |
Related to these features |
Discovery |
logging.time_based_logging.authentication
dds.participant.logging.time_based_logging.authentication.timeout |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Print warning message when the authentication operation time exceeds this time threshold. The format for the threshold is #s#ms#us#ns. |
Related to these features |
DDS Secure |
logging.time_based_logging.event
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Print warning message when the event start/execution time exceeds this time threshold. The format for the threshold is #s#ms#us#ns. |
Related to these features |
Logging |
logging.time_based_logging.process_received_message
dds.participant.logging.time_based_logging.process_received_message.timeout |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Print warning message when processing a received message operation exceeds this time threshold. The format for the threshold is #s#ms#us#ns. |
Related to these features |
Transport |
dds.participant.logging.time_based_logging.process_received_message.tracked_ports |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Print warning message when the processing of a received message on a specific port exceeds the time threshold set in dds.participant.logging.time_based_logging.process_received_message.timeout. |
Related to these features |
Logging |
logging.time_based_logging.send
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Print warning message when send operation time exceeds this time threshold. The format for the threshold is #s#ms#us#ns. |
Related to these features |
Transport |
protocol
May be set in |
DomainParticipant |
Applies to |
DataWriter |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Used to adjust the overhead of the RTPS protocol without including security. This property is still supported, but deprecated in 6.1.2. |
Related to these features |
Reliability |
The property has been deprecated in version |
6.1.2 |
trust_plugins
dds.participant.trust_plugins.key_revision_max_history_depth |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
Controls the number of key revisions that are used to encode samples in the DataWriters’ queues. Must be 0 or between 7 and 1000000. If 0, then key revisions are disabled. A greater key_revision_max_history_depth will further delay the need to reencode writer queue historical samples as new key revisions are generated, but it will increase the memory footprint of the DomainParticipant. The memory used for this is preallocated, and it is roughly equal to 36 bytes (or 164 bytes if the DomainParticipant has at least one DataWriter using ODBC writer history) multiplied by the key_revision_max_history_depth. If there is at least one reliable DataWriter that is protecting its payload, then the DomainParticipant will send 7 key revisions instead of just 1 to each late joiner DomainParticipant. Each key revision adds about 128 bytes of network traffic, so that’s 128 * (7 - 1) = 768 more bytes per late joiner DomainParticipant. |
Related to these features |
DDS Secure |
dds.participant.trust_plugins.max_removed_participants_per_key_revision |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
When enabling security, the Security Plugins keep a minimum state associated with each remote participant after the remote participant is removed. This state is used to ensure that removed remote participants whose identity credentials are invalidated after their removal are properly banished. This property controls the maximum number of remote participants for which this minimum state is maintained. Upon reaching this maximum number, the Security Plugins will automatically banish ignored participants, and the list of minimum states is cleared away. Before reaching this maximum number, if any removed participants have their identity credential invalidated (e.g., their certificate expires or gets revoked), then the Security Plugins will automatically banish ignored participants. A higher number for this property value will increase memory requirements of the local participant on systems with a high number of remote participants joining and leaving the system, and it will make automatic banishing less frequent. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
mutable |
Default Value |
|
Pattern value |
|
Description |
Configures a (semicolon-separated) whitelist of subject names for authenticated Domain Participants. If set (even if empty), authenticated Domain Participants will be allowed into the system only if their subject name matches one of the ones in the whitelist. Any authenticated Domain Participant not matching the whitelist will be ignored automatically. Since the whitelist is enforced only on authenticated Domain Participants, this property does not impact allowed non-authenticated participants: if allow_unauthenticated_participants is true, participants not using security and participants failing authentication early will still be allowed into the system. If the list is modified once the Domain Participant is enabled, any previously ignored Domain Participant will be unignored, which will create an opportunity to successfully authenticate if it is now part of the updated whitelist (if not, the Domain Participant will be ignored as usual). This property has no effect when not using the Security Plugins. |
Related to these features |
DDS Secure |
authentication_request_delay
dds.participant.trust_plugins.authentication_request_delay.sec |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
Controls the delay in seconds before sending an authentication_request to the remote participant. |
Related to these features |
DDS Secure |
authentication_request_timeout
dds.participant.trust_plugins.authentication_request_timeout.sec |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
It determines the timeout (in seconds) for authentication negotiations started from an authentication request message (authentication request is a DDS Security 1.1 mechanism to securely recover from an asymmetric liveliness loss). If set to a value greater than authentication_timeout, then it will be set to authentication_timeout. |
Related to these features |
DDS Secure |
authentication_timeout
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
Controls the maximum time in seconds that an ongoing authentication can remain without completing. |
Related to these features |
DDS Secure |
certificate_expiration_advance_notice_duration
dds.participant.trust_plugins.certificate_expiration_advance_notice_duration.sec |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
mutableUntilEnable |
Default Value |
|
Min-Max value |
|
Description |
Controls how much time in advance a DomainParticipantListener callback should notify the user when the local DomainParticipant’s certificate is about to expire. |
Related to these features |
DDS Secure |
certificate_expiration_advance_notice_reminder_period
dds.participant.trust_plugins.certificate_expiration_advance_notice_reminder_period.sec |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Mutability type |
mutableUntilEnable |
Default Value |
|
Min-Max value |
|
Description |
Controls how often (in seconds) a DomainParticipantListener callback should remind the user of a soon-to-be expired certificate. |
Related to these features |
DDS Secure |
max_key_redistribution_delay
dds.participant.trust_plugins.max_key_redistribution_delay.sec |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Mutability type |
immutable |
Default Value |
|
Min-Max value |
|
Description |
Controls the maximum time in seconds between generating and using a new key (revision). After this time, remote DomainParticipants that have not yet acknowledged the new key (revision) will be completely removed. Must be -1 or between 1 and INT_MAX. If -1, then the local DomainParticipant will wait indefinitely for acknowledgments of the new key (revision). |
Related to these features |
DDS Secure |
wire_protocol
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Determines which CRC algorithm to use if the participantQos.wire_protocol.compute_crc QoS is enabled. The number in the name indicates the length of the CRC in bits. All values enable RTPS Header Extension, except CRC_32_LEGACY (deprecated), which enables an rti-specific CRC algorithm deprecated in Connext 7.2.0. The other values represent the algorithms described in the RTPS Specification. CRC_64 is not currently supported. |
Related to these features |
Checksum |
dds.sample_assignability
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
When set to 1, samples containing an unknown enumerator can be successfully deserialized to the default enumeration value. |
Related to these features |
Type System |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
integer |
Default Value |
|
Possible values |
|
Description |
When set to 0, received samples containing a union discriminator value that selects a union member on the DataWriter but not on the DataReader are dropped. When set to 1, received samples containing a union discriminator value that selects a union member on the DataWriter but not on the DataReader are set to the default union value on the DataReader. When set to 2, received samples containing a union discriminator value that selects a union member on the DataWriter but not on the DataReader preserve the discriminator value and do not select any union member on the DataReader. |
Related to these features |
Type System |
dds.sec.access
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
The signed document that specifies the level of security required per domain and per topic. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
The signed document that specifies the access control permissions per domain and per topic. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
This Permissions Certificate Authority is used for signing access control governance and permissions XML files and verifying the signatures of those files. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
It specifies how to protect messages when using pre-shared key protection (don’t protect them, protect only their integrity, or protect both their integrity and confidentiality) |
Related to these features |
DDS Secure |
dds.sec.auth
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
This Identity Certificate Authority is used for signing authentication certificate files. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
mutable |
Default Value |
|
Pattern value |
|
Description |
The private key associated with the first certificate. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
The password used to decrypt the private_key. |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Pattern value |
|
Description |
The private key associated with the first certificate. |
Related to these features |
DDS Secure |
dds.sec.crypto
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
mutable |
Default Value |
|
Pattern value |
|
Description |
PSK protection uses this pre-shared key seed (in combination with publicly available data) to derive the key used for encoding RTPS messages. One acceptable format is “data:,<ID>:<SEED>”, to provide the seed explicitly in the property value, where <ID> is a unique number identifying the <SEED> (between 0 and 254). Another acceptable format is “file:<FILENAME>”, which allows providing the seed in a supplemental file. The content of the file has to follow the “<ID>:<SEED>” format. The “file:” prefix is optional. The <SEED> string shall contain up to 512 ASCII printable characters (character codes 32 to 126, both included), except that the first and last characters of the <SEED> shall not be the space character (character code 32). |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
Algorithm used to protect messages when using pre-shared key protection |
Related to these features |
DDS Secure |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Mutability type |
immutable |
Default Value |
|
Possible values |
|
Description |
The algorithm used for encrypting and decrypting data and metadata. It affects the user endpoints, the builtin topics (discovery, service request, and liveliness), and the DomainParticipant. |
Related to these features |
DDS Secure |
dds.sys_info
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Min-Max value |
|
Description |
Time when the executable was created. |
Related to these features |
System Info |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Name and full path of the executable. |
Related to these features |
System Info |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Min-Max value |
|
Description |
Time when the execution started. |
Related to these features |
System Info |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Hostname |
Related to these features |
System Info |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Min-Max value |
|
Description |
Process ID |
Related to these features |
System Info |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Architecture for which the library was compiled. |
Related to these features |
System Info |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Username that is running the process. |
Related to these features |
System Info |
dds.transport
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Comma-separated strings indicating the prefix names of all plugins that will be loaded by Connext DDS. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Minimum version that the transport should be compatible with. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Communicate between Connext DDS 5.2.0 and previous releases. This property is still supported, but deprecated in favour of dds.transport.minimum_compatibility_version. |
Related to these features |
Transport |
The property has been deprecated in version |
6.1.0 |
TCPv4.tcp1
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Used to register the transport plugin returned by NDDS_Transport_TCPv4_create() (as specified by <TCP_prefix>.create_function) to the DomainParticipant. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
The TCP transport can be configured to bind all sockets to a specified interface. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.client_connection_negotiation_timeout |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Timeout (in seconds) for negotiating a client data connection. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
If used, must be “NDDS_Transport_TCPv4_create”. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Defines the function pointer to the TCP transport plugin creation function. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Disables detection of network interface changes. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Disables the TCP nagle algorithm. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Configures the sending of KEEP_ALIVE messages in TCP. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Forces asynchronous send. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
When set to 1, forces the checking of the CRC for received RTI TCP messages. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from using the IP loopback interface. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Timeout (in seconds) for the initial handshake for a connection. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the period in milliseconds to query for changes in the state of all the interfaces. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the interval in seconds between KEEP_ALIVE retries. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
The maximum number of KEEP_ALIVE retries before dropping the connection. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the interval of inactivity in seconds that causes TCP to generate a KEEP_ALIVE message. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
If used, must be ‘nddstransporttcp’. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
mask |
Default Value |
|
Min-Max value |
|
Description |
Bitmap that specifies the verbosity of log messages from the transport. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
The maximum size of a TCP segment. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
When set to 1, the TCP transport plugin will perform a session negotiation that will help external load balancers identify all the connections associated with a particular session between two Connext DDS applications. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum number of outstanding connection cookies allowed by the transport when acting as a server . |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.outstanding_connection_cookies_life_span |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum lifespan (in seconds) of the cookies associated with pending connections. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Min-Max value |
|
Description |
Public IP address and port (WAN address and port) (separated with ‘:’) associated with the transport instantiation. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Size, in bytes, of the receive buffer of a socket used for receiving. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
mask |
Default Value |
|
Min-Max value |
|
Description |
Bitmap that specifies the verbosity of security related log messages from the transport. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
When set to 1, enables the computation of the CRC for sent RTI TCP messages. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Controls the maximum time (in seconds) the low-level sendto() function is allowed to block the caller thread when the TCP send buffer becomes full. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Size, in bytes, of the send buffer of a socket used for sending. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Private IP port (inside the LAN) used by the transport to accept TCP connections. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.server_connection_negotiation_timeout |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Timeout (in seconds) for negotiating a server data connection. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
The backlog parameter determines what is the maximum length of the queue of pending connections. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Indicates if the allocation settings in write_buffer_allocation are global to the transport or per destination. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Configures the socket monitoring API used by the transport. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
pointer |
Pattern value |
|
Description |
Defines the function pointer to the TLS Support creation function. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
pointer |
Pattern value |
|
Description |
Defines the function pointer to the TLS Support deletion function. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Sets the high value of the output range to IPv4 TOS. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Sets the low value of the output range to IPv4 TOS. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Mask for the transport priority field. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Changes the default OS TCP User Timeout configuration. |
Related to these features |
Transport |
connection_liveliness
dds.transport.TCPv4.tcp1.connection_liveliness.assertions_per_lease_duration |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Configures the connection liveliness feature. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Configures the connection liveliness feature. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.connection_liveliness.lease_duration |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Configures the connection liveliness feature. |
Related to these features |
Transport |
control_attribute_allocation
dds.transport.TCPv4.tcp1.control_attribute_allocation.incremental_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to control message attributes. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.control_attribute_allocation.initial_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to control message attributes. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.control_attribute_allocation.max_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to control message attributes. |
Related to these features |
Transport |
control_buffer_allocation
dds.transport.TCPv4.tcp1.control_buffer_allocation.incremental_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to buffers used to serialize and send control messages. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.control_buffer_allocation.initial_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to buffers used to serialize and send control messages. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.control_buffer_allocation.max_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to buffers used to serialize and send control messages. |
Related to these features |
Transport |
control_message_allocation
dds.transport.TCPv4.tcp1.control_message_allocation.incremental_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to control messages. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.control_message_allocation.initial_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to control messages. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.control_message_allocation.max_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to control messages. |
Related to these features |
Transport |
event_thread
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
mask |
Default Value |
|
Possible values |
|
Description |
Configures the event thread used by the TCP Transport plugin for providing some features. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Possible values |
|
Description |
Configures the event thread used by the TCP Transport plugin for providing some features. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Pattern value |
|
Min-Max value |
|
Description |
Configures the event thread used by the TCP Transport plugin for providing some features. |
Related to these features |
Transport |
parent
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name that can be used by the transport. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Possible values |
|
Description |
Must be set to one of the listed possible values. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name that will not be used by the transport. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.parent.gather_send_buffer_count_max |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum number of valid interfaces that will be used from the allow_interfaces_list |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
The maximum size of a message in bytes that can be sent or received by the transport plugin. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Prefix used to name the transport threads. |
Related to these features |
Transport |
read_buffer_allocation
dds.transport.TCPv4.tcp1.read_buffer_allocation.incremental_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to read buffers. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.read_buffer_allocation.initial_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to read buffers. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to read buffers. |
Related to these features |
Transport |
tls.cipher
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
List of available TLS ciphers when communicating with 6.0.0 or below. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
List of available TLS ciphersuites when communicating with 6.0.1 or above. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
List of available Diffie-Hellman (DH) key files. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
ID of OpenSSL cipher engine to request. |
Related to these features |
Transport |
tls.identity
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
String containing an identifying certificate (in PEM format) or certificate chain (appending intermediate CA certs in order). |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.tls.identity.certificate_chain_file |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
File containing identifying certificate (in PEM format) or certificate chain (appending intermediate CA certs in order). |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
String containing private key (in PEM format). |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
File containing private key (in PEM format). |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
A string that specifies the password for the private key. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
String containing additional RSA private key (in PEM format). |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
File containing additional RSA private key (in PEM format). |
Related to these features |
Transport |
tls.verify
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
A string that specifies the name of a file containing Certificate Authority certificates. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
A string that specifies paths to directories containing Certificate Authority certificates. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Name of the file containing the Certificate Revocation List. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum certificate chain length for verification. |
Related to these features |
Transport |
windows_iocp
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Configures I/O completion ports. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Configures I/O completion ports. |
Related to these features |
Transport |
write_buffer_allocation
dds.transport.TCPv4.tcp1.write_buffer_allocation.incremental_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to buffers used for asynchronous (non-blocking) write. |
Related to these features |
Transport |
dds.transport.TCPv4.tcp1.write_buffer_allocation.initial_count |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to buffers used for asynchronous (non-blocking) write. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Allocation settings applied to buffers used for asynchronous (non-blocking) write. |
Related to these features |
Transport |
UDPv4.builtin
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Aliases used to register the transport to the DomainParticipant. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Disables detection of network interface changes. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><disable_interface_tracking> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><force_interface_poll_detection> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from using the IP loopback interface. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><ignore_loopback_interface> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><ignore_nonrunning_interfaces> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
This property is only supported on Windows platforms with statically configured IP addresses. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the period in milliseconds to query for changes in the state of all the interfaces. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><interface_poll_period> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Controls how long Connext DDS will retry to join a multicast group with a new network interface before withdrawing. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><join_multicast_group_timeout> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Allows the transport plugin to use multicast for sending and receiving. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><multicast_enabled> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from putting multicast packets onto the loopback interface. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><multicast_loopback_disabled> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Value for the time-to-live parameter for all multicast sends using this plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><multicast_ttl> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from doing a zero copy. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Port offset to allow coexistence with other instances of UDP transport. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><port_offset> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size in bytes of protocol overhead, including headers. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><protocol_overhead_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Public IP address associated with the transport instantiation. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><public_address> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Size in bytes of the receive buffer of a socket used for receiving. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><recv_socket_buffer_size> |
dds.transport.UDPv4.builtin.reuse_multicast_receive_resource |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Controls whether or not to reuse receive resources. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><reuse_multicast_receive_resource> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Controls the blocking behavior of send sockets. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><send_blocking> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
This property specifies whether to send a PING message before commencing the discovery process. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><send_ping> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Size in bytes of the send buffer of a socket used for sending. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><send_socket_buffer_size> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Sets the high value of the output range to IPv4 TOS. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><transport_priority_mapping_high> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Sets the low value of the output range to IPv4 TOS. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><transport_priority_mapping_low> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Mask for the transport priority field. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><transport_priority_mask> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Allows the transport plugin to use unicast UDP for sending and receiving. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><unicast_enabled> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Specifies whether the UDP checksum will be computed. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><use_checksum> |
parent
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name that can be used by the transport. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><allow_interfaces_list> |
dds.transport.UDPv4.builtin.parent.allow_multicast_interfaces_list |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><allow_multicast_interfaces_list> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name that will not be used by the transport. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><deny_interfaces_list> |
dds.transport.UDPv4.builtin.parent.deny_multicast_interfaces_list |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><deny_multicast_interfaces_list> |
dds.transport.UDPv4.builtin.parent.gather_send_buffer_count_max |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><gather_send_buffer_count_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum number of valid interfaces that will be used from the allow_interfaces_list |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Possible values |
|
Description |
The maximum size of a message in bytes that can be sent or received by the transport plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><message_size_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
String |
Default Value |
|
Possible values |
|
Description |
A bitmap that defines various properties of the transport to the Connext DDS core. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><properties_bitmap> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Prefix used to name the transport threads. |
Related to these features |
Transport |
UDPv4_WAN.builtin
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Aliases used to register the transport to the DomainParticipant. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the period in milliseconds at which BINDING PINGS messages are sent to keep NAT mappings open |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><binding_ping_period> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
json |
Description |
Configures the mapping between <RTPS ports>, <UDP receive host ports>, and <UDP receive public ports>. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><comm_ports> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Disables detection of network interface changes. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><disable_interface_tracking> |
dds.transport.UDPv4_WAN.builtin.force_interface_poll_detection |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><force_interface_poll_detection> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from using the IP loopback interface. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><ignore_loopback_interface> |
dds.transport.UDPv4_WAN.builtin.ignore_nonrunning_interfaces |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><ignore_nonrunning_interfaces> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
This property is only supported on Windows platforms with statically configured IP addresses. |
Related to these features |
Transport |
The property has been deprecated in version |
6.1.0 |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the period in milliseconds to query for changes in the state of all the interfaces. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><interface_poll_period> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from doing a zero copy. |
Related to these features |
Transport |
The property has been deprecated in version |
6.1.0 |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Only required if statically linking the Real-Time Wan Transport (RWT) support library. Must be set to the stringified pointer value of RWT support library’s NDDS_Transport_UDP_WAN_Library_is_plugin_enabled function. Please refer to the RWT documentation for details. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Port offset to allow coexistence with non-WAN UDP transport. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><port_offset> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size in bytes of protocol overhead, including headers. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><protocol_overhead_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Public IP address associated with the transport instantiation. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><public_address> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Size in bytes of the receive buffer of a socket used for receiving. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><recv_socket_buffer_size> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Controls the blocking behavior of send sockets. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><send_blocking> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
This property specifies whether to send a PING message before commencing the discovery process. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><send_ping> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Size in bytes of the send buffer of a socket used for sending. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><send_socket_buffer_size> |
dds.transport.UDPv4_WAN.builtin.transport_priority_mapping_high |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Sets the high value of the output range to IPv4 TOS. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><transport_priority_mapping_high> |
dds.transport.UDPv4_WAN.builtin.transport_priority_mapping_low |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Sets the low value of the output range to IPv4 TOS. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><transport_priority_mapping_low> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Mask for the transport priority field. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><transport_priority_mask> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Specifies whether the UDP checksum will be computed. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><use_checksum> |
parent
dds.transport.UDPv4_WAN.builtin.parent.allow_interfaces_list |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name that can be used by the transport. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><allow_interfaces_list> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name that will not be used by the transport. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><deny_interfaces_list> |
dds.transport.UDPv4_WAN.builtin.parent.gather_send_buffer_count_max |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><gather_send_buffer_count_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum number of valid interfaces that will be used from the allow_interfaces_list |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Possible values |
|
Description |
The maximum size of a message in bytes that can be sent or received by the transport plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><message_size_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
String |
Default Value |
|
Possible values |
|
Description |
A bitmap that defines various properties of the transport to the Connext DDS core. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4_wan><properties_bitmap> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Prefix used to name the transport threads. |
Related to these features |
Transport |
UDPv6.builtin
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Aliases used to register the transport to the DomainParticipant. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Disables detection of network interface changes. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><disable_interface_tracking> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Specifies whether the UDPv6 transport will process IPv4 addresses. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><enable_v4mapped> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><force_interface_poll_detection> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from using the IP loopback interface. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><ignore_loopback_interface> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><ignore_nonrunning_interfaces> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the period in milliseconds to query for changes in the state of all the interfaces. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><interface_poll_period> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Controls how long Connext DDS will retry to join a multicast group with a new network interface before withdrawing. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><join_multicast_group_timeout> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Allows the transport plugin to use multicast for sending and receiving. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><multicast_enabled> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from putting multicast packets onto the loopback interface. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><multicast_loopback_disabled> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Value for the time-to-live parameter for all multicast sends using this plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><multicast_ttl> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Prevents the transport plugin from doing a zero copy. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Port offset to allow coexistence with other instances of UDP transport. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><port_offset> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum size in bytes of protocol overhead, including headers. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><protocol_overhead_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Public IP address associated with the transport instantiation. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><public_address> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Size in bytes of the receive buffer of a socket used for receiving. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><recv_socket_buffer_size> |
dds.transport.UDPv6.builtin.reuse_multicast_receive_resource |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Controls whether or not to reuse receive resources. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><reuse_multicast_receive_resource> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Controls the blocking behavior of send sockets. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv4><send_blocking> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
This property specifies whether to send a PING message before commencing the discovery process. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><send_ping> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Size in bytes of the send buffer of a socket used for sending. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><send_socket_buffer_size> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Sets the high value of the output range to IPv4 TOS. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><transport_priority_mapping_high> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Sets the low value of the output range to IPv4 TOS. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><transport_priority_mapping_low> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Mask for the transport priority field. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><transport_priority_mask> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Allows the transport plugin to use unicast UDP for sending and receiving. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><unicast_enabled> |
parent
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name that can be used by the transport. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><allow_interfaces_list> |
dds.transport.UDPv6.builtin.parent.allow_multicast_interfaces_list |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><allow_multicast_interfaces_list> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name that will not be used by the transport. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><deny_interfaces_list> |
dds.transport.UDPv6.builtin.parent.deny_multicast_interfaces_list |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
A list of strings, each identifying a range of interface addresses or an interface name. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><deny_multicast_interfaces_list> |
dds.transport.UDPv6.builtin.parent.gather_send_buffer_count_max |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><gather_send_buffer_count_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Maximum number of valid interfaces that will be used from the allow_interfaces_list |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Possible values |
|
Description |
The maximum size of a message in bytes that can be sent or received by the transport plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><message_size_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
String |
Default Value |
|
Possible values |
|
Description |
A bitmap that defines various properties of the transport to the Connext DDS core. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><udpv6><properties_bitmap> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Prefix used to name the transport threads. |
Related to these features |
Transport |
lbrtps
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Aliases used to register the LBRTPS transport plugin with the DomainParticipant. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The name of the function that will be called by Connext DDS to create an instance of the LBRTPS transport. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The name of the dynamic library that contains the LBRTPS transport plugin implementation. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Name of the plugin to be loaded by the LBRTPS transport. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Possible values |
|
Description |
The verbosity for the plugin, for debugging purposes. |
Related to these features |
Transport |
rtps_header
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Whether or not to eliminate the 4-byte protocol field in the RTPS header. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Whether or not to eliminate the 2-byte vendorId field in the RTPS header. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Whether or not to eliminate the 2-byte version field in the RTPS header. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Min-Max value |
|
Description |
The reduce_guidPrefix field is composed of 12 bytes that represent 3 different fields of 4 bytes each: hostId, appId and instanceId. |
Related to these features |
Transport |
submessage_header
dds.transport.lbrtps.submessage_header.combine_submessageId_with_flags |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Combine the first two fields in the SubmessageHeader; do not use all the bits. |
Related to these features |
Transport |
submessages
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Min-Max value |
|
Description |
Many submessage kinds include two fields: readerId and writerId. You may be able to reduce the size of these fields if you know ahead of time how many DataReaders and DataWriters you will have. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Some submessage kinds keep track of the number of submessages received by using an 8-byte sequence number field. You can reduce the number of bytes used for the sequence number by using this property. |
Related to these features |
Transport |
shmem.builtin
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Aliases used to register the transport to the DomainParticipant. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Enables UDP debugging when using shared memory. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><enable_udp_debugging> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Host ID used to generate the shared memory transport network address. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><host_id> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Mutability type |
mutableUntilEnable |
Default Value |
|
Min-Max value |
|
Description |
The total number of bytes that can be buffered in the receive queue. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><receive_buffer_size> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Mutability type |
mutableUntilEnable |
Default Value |
|
Min-Max value |
|
Description |
Number of messages that can be buffered in the receive queue. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><received_message_count_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Min-Max value |
|
Description |
IP address to which shared memory traffic will be published |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><udp_debugging_address> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
unsigned integer |
Default Value |
|
Min-Max value |
|
Description |
Port to which shared memory traffic will be published. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><udp_debugging_port> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
This property only applies when the WireProtocol QoS policy (specifically rtps_auto_id_kind) is set to DDS_RTPS_AUTO_ID_FROM_UUID. Consider using the transport QoS or the newer dds.transport.minimum_compatibility_version property. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><use_530_from_uuid_locator> |
parent
dds.transport.shmem.builtin.parent.gather_send_buffer_count_max |
|
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><gather_send_buffer_count_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
The maximum size of a message in bytes that can be sent or received by the transport plugin. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><message_size_max> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
A bitmap that defines various properties of the transport to the Connext DDS core. |
Related to these features |
Transport |
The property has been promoted to |
<domain_participant_qos><transport_builtin><shmem><properties_bitmap> |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Prefix used to name the transport threads. |
Related to these features |
Transport |
zrtps
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Defines the compression level that the compression algorithm will use for all RTPS packages. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Aliases used to register the ZRTPS transport plugin with the DomainParticipant. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
Must be set to ZRTPS_Transport_create_plugin. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Sets the name of a user’s external library that is to be located and used by the ZRTPS transport plugin. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the size for small, medium, and large RTPS packages. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The value must be rtizrtps. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Specifies the size for small, medium, and large RTPS packages. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Possible values |
|
Description |
Configures the validation of the properties. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Pattern value |
|
Description |
The required property, dds.transport.zrtps.subtransport, specifies the plugin to be loaded by the ZRTPS transport. Supported subtransports are UDPv4 or a user-specified transport. Connext DDS builtin transports other than UDPv4 are not currently supported as subtransports. Once you set the value for a subtransport, the names of all the properties for that subtransport should be in the form dds.transport.lbrtps.<subtransport>.<property>. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
The verbosity for the plugin, for debugging purposes. |
Related to these features |
Transport |
compression_level
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Defines the compression level that the compression algorithm will use for large RTPS packages. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Defines the compression level that the compression algorithm will use for medium RTPS packages. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Defines the compression level that the compression algorithm will use for small RTPS packages. |
Related to these features |
Transport |
compression_library
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Specifies the compression algorithm to be used for large RTPS packages. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Specifies the compression algorithm to be used for medium RTPS packages. |
Related to these features |
Transport |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
enum |
Default Value |
|
Possible values |
|
Description |
Specifies the compression algorithm to be used for small RTPS packages. |
Related to these features |
Transport |
dds.type_consistency
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Controls whether member names are taken into consideration for type assignability. |
Related to these features |
Type System |
The property has been deprecated by |
<datareader_qos><type_consistency><ignore_member_names> |
May be set in |
DataReader |
Applies to |
DataReader |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Controls whether sequence bounds are taken into consideration for type assignability. |
Related to these features |
Type System |
The property has been deprecated by |
<datareader_qos><type_consistency><ignore_sequence_bounds> |
dds.xtypes
May be set in |
DomainParticipant |
Applies to |
DataWriter |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
The compliance mask configures different aspects of the Extended CDR encoding (XCDR and XCDR2) for a DataWriter and DataReader |
Related to these features |
Type System |
rti.monitor
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
pointer |
Default Value |
|
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Related to these features |
Monitor |
config
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
This boolean value specifies whether or not Monitoring Library should collect CPU and memory usage statistics for the process in the topic rti/dds/monitoring/domainParticipantDescription. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
To create a separate participant that will be used to publish monitoring information in the application, set this to the domain ID that you want to use for the newly created participant. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Period of time to sample and publish all monitoring topics, in units of seconds. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
mask |
Default Value |
|
Possible values |
|
Description |
Describes the type of thread. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Description |
Priority of the thread used to sample and publish monitoring data. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Description |
Stack size used for the thread that samples and publishes monitoring data. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Specifies the name of the QoS library that you want to use for creating entities in the monitoring library (if you do not want to use default QoS values as set by the monitoring library). |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Specifies the name of the QoS profile that you want to use for creating entities in the monitoring library (if you do not want to use the default QoS values). |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
Monitoring Library obtains all statuses of all entities in the Connext DDS application. This boolean value controls whether or not the change counts in those statuses are reset by Monitoring Library. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
This boolean value controls whether or not the entities created internally by Monitoring Library should be included in the entity counts published by the participant entity statistics topic. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
If set to true, DomainParticipant PropertyQosPolicy name and value pairs will not be sent out through the domainParticipantDescriptionTopic. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
boolean |
Default Value |
|
Possible values |
|
Description |
If set to true, DataReader PropertyQosPolicy name and value pairs will not be sent out through the dataReaderDescriptionTopic. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Filter for monitoring topics, with regular expression matching syntax as specified in the Connext DDS documentation (similar to the POSIX fnmatch syntax). |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
string |
Default Value |
|
Pattern value |
|
Description |
Filter for user topics, with regular expression matching syntax as specified in the Connext DDS documentation (similar to the POSIX fnmatch syntax). |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Sets the verbosity on the monitoring library for debugging purposes. |
Related to these features |
Monitor |
May be set in |
DomainParticipant |
Applies to |
DomainParticipant |
Type |
integer |
Default Value |
|
Min-Max value |
|
Description |
Controls the threshold at which dynamic memory allocation is used, expressed as a number of bytes. |
Related to these features |
Monitor |