List of Properties Per Entity¶
DomainParticipant¶
com.rti.serv¶
| com.rti.serv.load_plugin | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | The prefix name of the security plugin suite that will be loaded by Connext DDS. |
| Tags | DDS Secure |
secure¶
| com.rti.serv.secure.create_function | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Must be set to the security plugin suite creation function that is implemented by the library. |
| Tags | DDS Secure |
| com.rti.serv.secure.create_function_ptr | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Must be set to the security plugin suite creation function implemented by the library. |
| Tags | DDS Secure |
| com.rti.serv.secure.library | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Must be set to the dynamic library that implements the security plugin suite. |
| Tags | DDS Secure |
| com.rti.serv.secure.openssl_engine | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | The dynamic library that implements an OpenSSL engine. |
| Tags | DDS Secure |
access_control¶
| com.rti.serv.secure.access_control.alternative_permissions_authority_files | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .*(,.*)* |
| Description | A comma-separated list of alternative Permissions CA certificates. |
| Tags | DDS Secure |
| com.rti.serv.secure.access_control.use_530_logging_protection | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | How to set the value of <metadata_protection_kind> for the Builtin Logging Topic. |
| Tags | DDS Secure |
| com.rti.serv.secure.access_control.use_530_partitions | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | How to determine a match between a DataWriter’s or DataReader’s partitions and an ‘allowed partitions’ condition in a Permissions Document. |
| Tags | DDS Secure |
| com.rti.serv.secure.access_control.use_530_permissions_rules_precedence | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | How to deal with conflicting allow/deny rules in a Permissions Document. |
| Tags | DDS Secure |
authentication¶
| com.rti.serv.secure.authentication.alternative_ca_files | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .*(,.*)* |
| Description | A comma-separated list of alternative Identity CA certificates. |
| Tags | DDS Secure |
| com.rti.serv.secure.authentication.crl_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | This Certificate Revocation List keeps track of untrusted X.509 certificates. |
| Tags | DDS Secure |
| com.rti.serv.secure.authentication.keyform | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | pem |
| Possible values | engine pem |
| Description | The format of the private key specified by dds.sec.auth.private_key. |
| Tags | DDS Secure |
| com.rti.serv.secure.authentication.shared_secret_algorithm | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | ecdh |
| Possible values | dh ecdh |
| Description | The algorithm used to establish a shared secret during authentication. |
| Tags | DDS Secure |
cryptography¶
| com.rti.serv.secure.cryptography.encryption_algorithm | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | aes-128-gcm |
| Possible values | aes-128-gcm aes-192-gcm aes-256-gcm |
| Description | The algorithm used for encrypting and decrypting data and metadata. |
| Tags | DDS Secure |
| com.rti.serv.secure.cryptography.max_blocks_per_session | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned long long |
| Default Value | 0xffffffffffffffff |
| Min-Max value | [1,ULLONG_MAX] |
| Description | The number of message blocks that can be encrypted with the same key material. |
| Tags | DDS Secure |
| com.rti.serv.secure.cryptography.max_receiver_specific_macs | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,3275] |
| Description | The maximum number of receiver-specific Message Authentication Codes (MACs) that are appended to an encoded result. |
| Tags | DDS Secure |
| com.rti.serv.secure.cryptography.share_key_for_metadata_and_data_protection | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Indicator of whether the metadata and data encoding operations share the same key material or use different keys. |
| Tags | DDS Secure |
hmac_only¶
| com.rti.serv.secure.hmac_only.enabled | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Enables or disables the HMAC-only mode. |
| Tags | DDS Secure |
hmac_only.cryptography¶
| com.rti.serv.secure.hmac_only.cryptography.key | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | Sets the static HMAC key used to compute message signatures. |
| Tags | DDS Secure |
| com.rti.serv.secure.hmac_only.cryptography.max_blocks_per_session | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 0xffffffffffffffff |
| Min-Max value | [1,ULLONG_MAX] |
| 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. |
| Tags | DDS Secure |
logging¶
| com.rti.serv.secure.logging.log_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | The file that log messages are printed to. |
| Tags | DDS Secure Logging |
| com.rti.serv.secure.logging.log_level | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 3 |
| Min-Max value | [0,7] |
| Description | The logging verbosity level. |
| Tags | DDS Secure Logging |
| The property has been deprecated by | com.rti.serv.secure.logging.verbosity |
| com.rti.serv.secure.logging.verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | ERROR |
| Possible values | SILENT EMERGENCY ALERT CRITICAL ERROR WARNING NOTICE INFORMATIONAL DEBUG |
| Description | The logging verbosity level |
| Tags | DDS Secure Logging |
logging.distribute¶
| com.rti.serv.secure.logging.distribute.enable | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Controls whether security-related log messages should be distributed over a DDS DataWriter |
| Tags | DDS Secure Logging |
| com.rti.serv.secure.logging.distribute.profile | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | QoS Library and QoS profile used to create logging-related entities (Publisher, Topic and DataWriter). |
| Tags | DDS Secure Logging |
logging.distribute.queue¶
| com.rti.serv.secure.logging.distribute.queue.message_count_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 64 |
| Min-Max value | [0,UINT_MAX] |
| Description | Maximum number of log messages in the logging queue. |
| Tags | DDS Secure Logging |
| com.rti.serv.secure.logging.distribute.queue.message_size_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 792 |
| Min-Max value | [27,UINT_MAX] |
| Description | Maximum serialized size of a log message in the logging queue. |
| Tags | DDS Secure Logging |
| com.rti.serv.secure.logging.distribute.queue.size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 50688 |
| Min-Max value | [0,UINT_MAX] |
| Description | Size of the logging thread queue, in bytes. |
| Tags | DDS Secure Logging |
logging.distribute.thread¶
| com.rti.serv.secure.logging.distribute.thread.message_threshold | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 256 |
| Min-Max value | [0,UINT_MAX] |
| Description | Number of bytes to preallocate for the logging message string in the logging thread, beyond which dynamic allocation will occur. |
| Tags | DDS Secure Logging |
| com.rti.serv.secure.logging.distribute.thread.plugin_method_threshold | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 80 |
| Min-Max value | [0,UINT_MAX] |
| Description | Number of bytes to preallocate for the plugin method string in the logging thread, beyond which dynamic allocation will occur. |
| Tags | DDS Secure Logging |
dds.builtin_type¶
| dds.builtin_type.auto_register | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Register automatically the built-in types when a DomainParticipant is created. |
| Tags | Builtin Type |
dds.clock¶
| dds.clock.external_clock | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | realtime |
| Possible values | realtime system monotonic |
| Description | Comma-delimited list of clocks to use for the external clock, in the order of preference. |
| Tags | Clock |
| dds.clock.internal_clock | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | realtime |
| Possible values | realtime system monotonic |
| Description | Comma-delimited list of clocks to use for the internal clock, in the order of preference. |
| Tags | Clock |
dds.discovery.endpoint¶
| dds.discovery.endpoint.load_plugins | |
| 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. |
| Tags | Discovery |
lbediscovery¶
| dds.discovery.endpoint.lbediscovery.config_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .+\.xml |
| Description | The name of the discovery configuration file. |
| Tags | Discovery |
| dds.discovery.endpoint.lbediscovery.create_function | |
| 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. |
| Tags | Discovery |
| dds.discovery.endpoint.lbediscovery.library | |
| 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. |
| Tags | Discovery |
| dds.discovery.endpoint.lbediscovery.verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [-1,INT_MAX] |
| Description | The verbosity for the plugin, for debugging purposes. |
| Tags | Discovery Logging |
dds.discovery.participant¶
| dds.discovery.participant.load_plugins | |
| 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. |
| Tags | Discovery |
lbpdiscovery¶
| dds.discovery.participant.lbpdiscovery.config_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .+\.xml |
| Description | The name of the discovery configuration file. |
| Tags | Discovery |
| dds.discovery.participant.lbpdiscovery.create_function | |
| 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. |
| Tags | Discovery |
| dds.discovery.participant.lbpdiscovery.library | |
| 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. |
| Tags | Discovery |
| dds.discovery.participant.lbpdiscovery.verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [-1,INT_MAX] |
| Description | The verbosity for the plugin, for debugging purposes. |
| Tags | Discovery Logging |
dds.domain_participant¶
| dds.domain_participant.asynchronous_publisher_thread_destruction_timeout | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 10 |
| Min-Max value | [0,60] |
| Tags | Flow Controller |
| dds.domain_participant.domain_tag | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | ^.{0,255}$ |
| Description | A string defining the Domain Tag the DomainParticipant will propagate through Participant Discovery. |
| Tags | Discovery |
| dds.domain_participant.max_announced_locator_list_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 16 |
| Min-Max value | [0,16] |
| Description | A sequence of multicast settings used to configure the multicast addresses associated with a channel. |
| Tags | Discovery |
auto_throttle¶
| dds.domain_participant.auto_throttle.enable | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Configures the DomainParticipant to gather internal measurements (during DomainParticipant creation) that are required for the Auto Throttle feature. |
| Tags | 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 DataWriter |
| Type | enum |
| Default Value | DDS_EDF_FLOW_CONTROLLER_SCHED_POLICY |
| Possible values | DDS_RR_FLOW_CONTROLLER_SCHED_POLICY DDS_EDF_FLOW_CONTROLLER_SCHED_POLICY DDS_HPF_FLOW_CONTROLLER_SCHED_POLICY |
| Description | Specifies the scheduling policy to be used. |
| Tags | 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 DataWriter |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum number of bytes allowed to send for each token available. |
| Tags | Flow Controller |
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.max_tokens | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum number of tokens than can accumulate in the token bucket. |
| Tags | Flow Controller |
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.tokens_added_per_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [-1,INT_MAX] |
| Description | Number of tokens added to the token bucket per specified period. |
| Tags | Flow Controller |
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.tokens_leaked_per_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Number of tokens removed from the token bucket per specified period. |
| Tags | Flow Controller |
period¶
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.period.nanosec | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | unsigned integer |
| Default Value | 0 |
| Min-Max value | [0,UINT_MAX] |
| Description | Period for adding tokens to and removing tokens from the bucket in nanoseconds. |
| Tags | Flow Controller |
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.period.sec | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | integer |
| Default Value | 1 |
| Min-Max value | [0,INT_MAX] |
| Description | Period for adding tokens to and removing tokens from the bucket in seconds. |
| Tags | Flow Controller |
dds.license¶
| dds.license.license_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Sets the path to the license file |
| Tags | License |
| dds.license.license_string | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Sets the contents of the license. |
| Tags | License |
dds.participant¶
| dds.participant.property_validation_action | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | VALIDATION_ACTION_EXCEPTION |
| Possible values | VALIDATION_ACTION_WARNING VALIDATION_ACTION_EXCEPTION VALIDATION_ACTION_SKIP -1 0 1 |
| Description | configures the validation of the properties. |
| Tags | Other |
| dds.participant.use_45d_compatible_alignment_enforcement | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Accept RTPS messages with wrong alignment incorrectly. |
| Tags | Type System |
builtin_data_writer.protocol¶
| dds.participant.builtin_data_writer.protocol.disable_repair_piggyback_heartbeat | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents piggyback HBs from being sent with repair samples for builtin discovery topics |
| Tags | Reliability |
discovery_config¶
| dds.participant.discovery_config.disable_endpoint_security_info_propagation | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Participant may communicate for some combinations of inconsistent metadata/data protection kinds. |
| Tags | Discovery |
| dds.participant.discovery_config.disable_participant_security_info_propagation | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Participants may communicate for some combinations of inconsistent Governance’s RTPS, discovery, and liveliness configurations. |
| Tags | Discovery |
inter_participant_data_reader.protocol¶
| dds.participant.inter_participant_data_reader.protocol.disable_preemptive_nack | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataReader |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Disable preemptive Heartbeats and NACKs. |
| Tags | Discovery Reliability |
inter_participant_data_writer.protocol¶
| dds.participant.inter_participant_data_writer.protocol.disable_preemptive_heartbeat | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Disable preemptive Heartbeats and NACKs. |
| Tags | Discovery Reliability |
trust_plugins.authentication_request_delay¶
| dds.participant.trust_plugins.authentication_request_delay.sec | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 5 |
| Min-Max value | [0,INT_MAX] |
| Description | Controls the delay in seconds before sending an authentication_request to the remote participant. |
| Tags | DDS Secure |
trust_plugins.authentication_timeout¶
| dds.participant.trust_plugins.authentication_timeout.sec | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 60 |
| Min-Max value | [0,INT_MAX] |
| Description | Controls the maximum time in seconds that an ongoing authentication can remain without completing. |
| Tags | DDS Secure |
dds.sec.access¶
| dds.sec.access.governance | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | [file:\|data:,].* |
| Description | The signed document that specifies the level of security required per domain and per topic. |
| Tags | DDS Secure |
| dds.sec.access.permissions | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | [file:\|data:,].* |
| Description | The signed document that specifies the access control permissions per domain and per topic. |
| Tags | DDS Secure |
| dds.sec.access.permissions_ca | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | [file:\|data:,].* |
| Description | This Permissions Certificate Authority is used for signing access control governance and permissions XML files and verifying the signatures of those files. |
| Tags | DDS Secure |
dds.sec.auth¶
| dds.sec.auth.identity_ca | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | [file:\|data:,].* |
| Description | This Identity Certificate Authority is used for signing authentication certificate files. |
| Tags | DDS Secure |
| dds.sec.auth.identity_certificate | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | [file:\|data:,].* |
| Description | The private key associated with the first certificate. |
| Tags | DDS Secure |
| dds.sec.auth.password | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | The password used to decrypt the private_key. |
| Tags | DDS Secure |
| dds.sec.auth.private_key | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | [file:\|data:,].* |
| Description | The private key associated with the first certificate. |
| Tags | DDS Secure |
dds.sys_info¶
| dds.sys_info.creation_timestamp | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Min-Max value | [0,9999] |
| Description | Time when the executable was created. |
| Tags | System Info Default Discovery Propagation |
| dds.sys_info.executable_filepath | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Name and full path of the executable. |
| Tags | System Info Default Discovery Propagation |
| dds.sys_info.execution_timestamp | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Min-Max value | [0,9999] |
| Description | Time when the execution started. |
| Tags | System Info Default Discovery Propagation |
| dds.sys_info.hostname | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Hostname |
| Tags | System Info Default Discovery Propagation |
| dds.sys_info.process_id | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Min-Max value | [0,UINT_MAX] |
| Description | Process ID |
| Tags | System Info Default Discovery Propagation |
| dds.sys_info.target | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Architecture for which the library was compiled. |
| Tags | System Info Default Discovery Propagation |
| dds.sys_info.username | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Username that is running the process. |
| Tags | System Info Default Discovery Propagation |
dds.transport¶
| dds.transport.load_plugins | |
| 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. |
| Tags | Transport |
| dds.transport.use_510_compatible_locator_kinds | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Communicate between Connext DDS 5.2.0 and previous releases. |
| Tags | Transport |
DTLS.dtls1¶
| dds.transport.DTLS.dtls1.aliases | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | Plugin Name |
| Pattern value | .* |
| Description | Used to register the transport plugin returned by NDDS_Transport_DTLS_create() to the DomainParticipant. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.create_function | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Must be ‘NDDS_Transport_DTLS_create’ |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.create_function_ptr | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | pointer |
| Default Value | NULL |
| Description | Defines the function pointer to the DTLS transport plugin creation function. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.disable_interface_tracking | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Disables detection of network interface changes. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.dtls_connection_liveliness_interval | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 60 |
| Min-Max value | [0,UINT_MAX] |
| Description | Liveliness interval (multiple of resend interval) |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.dtls_handshake_resend_interval | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 1000 |
| Min-Max value | [0,UINT_MAX] |
| Description | DTLS handshake retransmission interval in milliseconds. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.force_interface_poll_detection | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.ignore_loopback_interface | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Possible values | -1 0 1 |
| Description | Prevents the transport plugin from using the IP loopback interface. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.ignore_nonrunning_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Possible values | 0 1 |
| Description | Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.interface_poll_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 500 |
| Min-Max value | [0,UINT_MAX] |
| Description | Specifies the period in milliseconds to query for changes in the state of all the interfaces. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.join_multicast_group_timeout | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 5000 |
| Min-Max value | [0,UINT_MAX] |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.library | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Must set to ‘libnddstransporttls.so’ (for UNIX/Solaris) or ‘nddstransporttls.dll’ (for Windows). |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.network_address | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | 0.0.0.0 |
| Min-Max value | [0,255] |
| Description | The network address at which to register this transport plugin. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.port_offset | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 144 |
| Min-Max value | [0,INT_MAX] |
| Description | Port offset to allow coexistence with non-secure UDP transport. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.recv_decode_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 65507 |
| Min-Max value | [0,INT_MAX] |
| Description | Size of buffer for decoding packets from wire. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.recv_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [0,INT_MAX] |
| Description | Size in bytes of the receive buffer of a socket used for sending. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.security_verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Min-Max value | [-1,INT_MAX] |
| Description | Specifies the verbosity of security related log messages from the transport. |
| Tags | Transport Transport Secure Logging |
| dds.transport.DTLS.dtls1.send_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [0,INT_MAX] |
| Description | Size in bytes of the send buffer of a socket used for sending. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.transport_priority_mapping_high | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0xFF |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the high value of the output range to IPv4 TOS. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.transport_priority_mapping_low | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the low value of the output range to IPv4 TOS. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.transport_priority_mask | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 0 |
| Min-Max value | [0,UINT_MAX] |
| Description | Mask for use of transport priority field. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Min-Max value | [-1,INT_MAX] |
| Description | Specifies the verbosity of log messages from the transport. |
| Tags | Transport Transport Secure Logging |
parent¶
| dds.transport.DTLS.dtls1.parent.address_bit_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 32 |
| Min-Max value | [INT_MIN,INT_MAX] |
| Description | Number of bits in a 16-byte address that are used by the transport. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.parent.allow_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .*(,.*)* |
| Description | A list of strings, each identifying a range of interface addresses. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.parent.deny_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .*(,.*)* |
| Description | A list of strings, each identifying a range of interface addresses. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.parent.gather_send_buffer_count_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 16 |
| Min-Max value | [INT_MIN,INT_MAX] |
| Description | Specifies the maximum number of buffers that Connext DDS can pass to the transport plugin’s send() function. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.parent.message_size_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 16384 |
| Min-Max value | [0,16384] |
| Description | The maximum size of a message in bytes that can be sent or received by the transport plugin. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.parent.properties_bitmap | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [INT_MIN,INT_MAX] |
| Description | A bitmap that defines various properties of the transport to the Connext DDS core. |
| Tags | Transport Transport Secure |
tls.cipher¶
| dds.transport.DTLS.dtls1.tls.cipher.cipher_list | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | List of available DTLS ciphers. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.tls.cipher.dh_param_files | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Possible values | 0-9 |
| Description | List of available Diffie-Hellman (DH) key files. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.tls.cipher.engine_id | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | String ID of OpenSSL cipher engine to request. |
| Tags | Transport Transport Secure |
tls.identity¶
| dds.transport.DTLS.dtls1.tls.identity.certificate_chain_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the name of a file containing an identifying certificate chain (in PEM format). |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.tls.identity.private_key_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the name of a file containing a private key (in PEM format) |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.tls.identity.private_key_password | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the password for the private key. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.tls.identity.rsa_private_key_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the name of a file containing an RSA private key (in PEM format). |
| Tags | Transport |
tls.verify¶
| dds.transport.DTLS.dtls1.tls.verify.ca_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the name of a file containing Certificate Authority certificates. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.tls.verify.ca_path | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies paths to directories containing Certificate Authority certificates. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.tls.verify.callback | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | NULL |
| Possible values | default verbose none |
| Description | NDDS_Transport_TLS_default_verify_callback() |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.tls.verify.verify_depth | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum certificate chain length for verification. |
| Tags | Transport Transport Secure |
| dds.transport.DTLS.dtls1.tls.verify.verify_peer | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | If non-zero, use mutual authentication when performing TLS handshake (default). |
| Tags | Transport Transport Secure |
TCPv4.tcp1¶
| dds.transport.TCPv4.tcp1.aliases | |
| 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. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.bind_interface_address | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | The TCP transport can be configured to bind all sockets to a specified interface. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.client_connection_negotiation_timeout | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 10 |
| Min-Max value | [1,INT_MAX] |
| Description | Timeout (in seconds) for negotiating a client data connection. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.create_function | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | If used, must be “NDDS_Transport_TCPv4_create”. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.create_function_ptr | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Defines the function pointer to the TCP transport plugin creation function. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.disable_interface_tracking | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Disables detection of network interface changes. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.disable_nagle | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Disables the TCP nagle algorithm. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.enable_keep_alive | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Configures the sending of KEEP_ALIVE messages in TCP. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.force_asynchronous_send | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Forces asynchronous send. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.force_crc_check | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | When set to 1, forces the checking of the CRC for received RTI TCP messages. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.force_interface_poll_detection | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.ignore_loopback_interface | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents the transport plugin from using the IP loopback interface. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.ignore_nonrunning_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.initial_handshake_timeout | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 10 |
| Min-Max value | [1,INT_MAX] |
| Description | Timeout (in seconds) for the initial handshake for a connection. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.interface_poll_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 500 |
| Min-Max value | [0,INT_MAX] |
| Description | Specifies the period in milliseconds to query for changes in the state of all the interfaces. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.keep_alive_interval | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Specifies the interval in seconds between KEEP_ALIVE retries. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.keep_alive_retry_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | The maximum number of KEEP_ALIVE retries before dropping the connection. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.keep_alive_time | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Specifies the interval of inactivity in seconds that causes TCP to generate a KEEP_ALIVE message. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.library | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | If used, must be ‘nddstransporttcp’. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.logging_verbosity_bitmap | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | mask |
| Default Value | -1 |
| Min-Max value | [0,INT_MAX] |
| Description | Bitmap that specifies the verbosity of log messages from the transport. |
| Tags | Transport Logging |
| dds.transport.TCPv4.tcp1.max_packet_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | The maximum size of a TCP segment. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.negotiate_session_id | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| 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. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.outstanding_connection_cookies | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 100 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum number of outstanding connection cookies allowed by the transport when acting as a server . |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.outstanding_connection_cookies_life_span | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [INT_MIN,INT_MAX] |
| Description | Maximum lifespan (in seconds) of the cookies associated with pending connections. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.public_address | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Min-Max value | [0,255] |
| Description | Public IP address and port (WAN address and port) (separated with ‘:’ ) associated with the transport instantiation. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.recv_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Size, in bytes, of the receive buffer of a socket used for receiving. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.security_logging_verbosity_bitmap | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | mask |
| Default Value | -1 |
| Min-Max value | [0,INT_MAX] |
| Description | Bitmap that specifies the verbosity of security related log messages from the transport. |
| Tags | Transport Transport Secure Logging |
| dds.transport.TCPv4.tcp1.send_crc | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | When set to 1, enables the computation of the CRC for sent RTI TCP messages. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.send_max_wait_sec | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 3 |
| Min-Max value | [0,INT_MAX] |
| 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. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.send_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Size, in bytes, of the send buffer of a socket used for sending. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.server_bind_port | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 7400 |
| Min-Max value | [0,INT_MAX] |
| Description | Private IP port (inside the LAN) used by the transport to accept TCP connections. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.server_connection_negotiation_timeout | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 10 |
| Min-Max value | [1,INT_MAX] |
| Description | Timeout (in seconds) for negotiating a server data connection. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.server_socket_backlog | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 5 |
| Min-Max value | [0,INT_MAX] |
| Description | The backlog parameter determines what is the maximum length of the queue of pending connections. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.socket_monitoring_kind | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | SELECT |
| Possible values | SELECT WINDOWS_IOCP WINDOWS_WAITFORMULTIPLEOBJECTS |
| Description | Configures the socket monitoring API used by the transport. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.tls_create_function_ptr | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | pointer |
| Pattern value | .* |
| Description | Defines the function pointer to the TLS Support creation function. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.tls_delete_function_ptr | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | pointer |
| Pattern value | .* |
| Description | Defines the function pointer to the TLS Support deletion function. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.transport_priority_mapping_high | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0xFF |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the high value of the output range to IPv4 TOS. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.transport_priority_mapping_low | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the low value of the output range to IPv4 TOS. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.transport_priority_mask | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Mask for the transport priority field. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.user_timeout | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Changes the default OS TCP User Timeout configuration. |
| Tags | 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 | 3 |
| Min-Max value | [0,INT_MAX] |
| Description | Configures the connection liveliness feature. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.connection_liveliness.enable | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Configures the connection liveliness feature. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.connection_liveliness.lease_duration | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 10 |
| Min-Max value | [0,INT_MAX] |
| Description | Configures the connection liveliness feature. |
| Tags | 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 | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Allocation settings applied to control message attributes. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.control_attribute_allocation.initial_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 2 |
| Min-Max value | [0,INT_MAX] |
| Description | Allocation settings applied to control message attributes. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.control_attribute_allocation.max_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Allocation settings applied to control message attributes. |
| Tags | 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 | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Allocation settings applied to buffers used to serialize and send control messages. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.control_buffer_allocation.initial_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 2 |
| Min-Max value | [0,INT_MAX] |
| Description | Allocation settings applied to buffers used to serialize and send control messages. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.control_buffer_allocation.max_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Allocation settings applied to buffers used to serialize and send control messages. |
| Tags | 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 | -1 |
| Min-Max value | [-MIN_INT,MAX_INT] |
| Description | Allocation settings applied to control messages. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.control_message_allocation.initial_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 2 |
| Min-Max value | [0,INT_MAX] |
| Description | Allocation settings applied to control messages. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.control_message_allocation.max_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Allocation settings applied to control messages. |
| Tags | Transport |
event_thread¶
| dds.transport.TCPv4.tcp1.event_thread.mask | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | mask |
| Default Value | PRIORITY_ENFORCE \| STDIO |
| Possible values | STDIO FLOATING_POINT REALTIME_PRIORITY PRIORITY_ENFORCE |
| Description | Configures the event thread used by the TCP Transport plugin for providing some features. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.event_thread.priority | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | THREAD_PRIORITY_NORMAL |
| Possible values | THREAD_PRIORITY_DEFAULT THREAD_PRIORITY_HIGH THREAD_PRIORITY_ABOVE_NORMAL THREAD_PRIORITY_NORMAL THREAD_PRIORITY_BELOW_NORMAL THREAD_PRIORITY_LOW |
| Description | Configures the event thread used by the TCP Transport plugin for providing some features. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.event_thread.stack_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | THREAD_STACK_SIZE_DEFAULT |
| Pattern value | THREAD_STACK_SIZE_DEFAULT |
| Min-Max value | [INT_MIN,INT_MAX] |
| Description | Configures the event thread used by the TCP Transport plugin for providing some features. |
| Tags | Transport |
parent¶
| dds.transport.TCPv4.tcp1.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. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.parent.classid | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | NDDS_TRANSPORT_CLASSID_TCPV4_LAN |
| Min-Max value | [INT_MIN,INT_MAX] |
| Possible values | NDDS_TRANSPORT_CLASSID_INVALID NDDS_TRANSPORT_CLASSID_ANY NDDS_TRANSPORT_CLASSID_TCPV4_WAN NDDS_TRANSPORT_CLASSID_TCPV4_LAN NDDS_TRANSPORT_CLASSID_TLSV4_LAN NDDS_TRANSPORT_CLASSID_TLSV4_WAN |
| Description | Must be set to one of the listed possible values. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.parent.deny_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. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.parent.gather_send_buffer_count_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 128 |
| Min-Max value | [0,INT_MAX] |
| Description | Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.parent.message_size_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 65536 |
| Min-Max value | [0,INT_MAX] |
| Description | The maximum size of a message in bytes that can be sent or received by the transport plugin. |
| Tags | 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 | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Allocation settings applied to read buffers. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.read_buffer_allocation.initial_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 2 |
| Min-Max value | [0,INT_MAX] |
| Description | Allocation settings applied to read buffers. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.read_buffer_allocation.max_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Allocation settings applied to read buffers. |
| Tags | Transport |
tls.cipher¶
| dds.transport.TCPv4.tcp1.tls.cipher.cipher_list | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | NULL |
| Possible values | RTITLS_CIPHER_LIST_DEFAULT RTITLS_CIPHER_LIST_ENCRYPT_HIGH RTITLS_CIPHER_LIST_UNENCRYPTED |
| Description | List of available (D)TLS ciphers. |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.cipher.dh_param_files | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Possible values | 0-9 |
| Description | List of available Diffie-Hellman (DH) key files. |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.cipher.engine_id | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | ID of OpenSSL cipher engine to request. |
| Tags | Transport Transport Secure |
tls.identity¶
| dds.transport.TCPv4.tcp1.tls.identity.certificate_chain | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | String containing an identifying certificate (in PEM format) or certificate chain (appending intermediate CA certs in order). |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.identity.certificate_chain_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | File containing identifying certificate (in PEM format) or certificate chain (appending intermediate CA certs in order). |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.identity.private_key | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | String containing private key (in PEM format). |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.identity.private_key_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | File containing private key (in PEM format). |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.identity.private_key_password | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the password for the private key. |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.identity.rsa_private_key | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | String containing additional RSA private key (in PEM format). |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.identity.rsa_private_key_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | File containing additional RSA private key (in PEM format). |
| Tags | Transport Transport Secure |
tls.verify¶
| dds.transport.TCPv4.tcp1.tls.verify.ca_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the name of a file containing Certificate Authority certificates. |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.verify.ca_path | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies paths to directories containing Certificate Authority certificates. |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.verify.crl_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | Name of the file containing the Certificate Revocation List. |
| Tags | Transport Transport Secure |
| dds.transport.TCPv4.tcp1.tls.verify.verify_depth | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [INT_MIN,INT_MAX] |
| Description | Maximum certificate chain length for verification. |
| Tags | Transport Transport Secure |
windows_iocp¶
| dds.transport.TCPv4.tcp1.windows_iocp.concurrency_value | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 1 |
| Min-Max value | [0,INT_MAX] |
| Description | Configures I/O completion ports. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.windows_iocp.thread_pool_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 2 |
| Min-Max value | [0,INT_MAX] |
| Description | Configures I/O completion ports. |
| Tags | 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 | 10 |
| Min-Max value | [0,INT_MAX] |
| Description | Allocation settings applied to buffers used for asynchronous (non-blocking) write. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.write_buffer_allocation.initial_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 4 |
| Min-Max value | [0,INT_MAX] |
| Description | Allocation settings applied to buffers used for asynchronous (non-blocking) write. |
| Tags | Transport |
| dds.transport.TCPv4.tcp1.write_buffer_allocation.max_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1000 |
| Min-Max value | [0,INT_MAX] |
| Description | Allocation settings applied to buffers used for asynchronous (non-blocking) write. |
| Tags | Transport |
UDPv4.builtin¶
| dds.transport.UDPv4.builtin.disable_interface_tracking | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Disables detection of network interface changes. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><public_address> |
| dds.transport.UDPv4.builtin.force_interface_poll_detection | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios. |
| Tags | Transport Builtin Transport |
| dds.transport.UDPv4.builtin.ignore_loopback_interface | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Possible values | -1 0 1 |
| Description | Prevents the transport plugin from using the IP loopback interface. |
| Tags | Transport Builtin Transport |
| dds.transport.UDPv4.builtin.ignore_nonrunning_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><ignore_nonrunning_interfaces> |
| dds.transport.UDPv4.builtin.ignore_nonup_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | This property is only supported on Windows platforms with statically configured IP addresses. |
| Tags | Transport Builtin Transport |
| dds.transport.UDPv4.builtin.interface_poll_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 500 |
| Min-Max value | [0,UINT_MAX] |
| Description | Specifies the period in milliseconds to query for changes in the state of all the interfaces. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><interface_poll_period> |
| dds.transport.UDPv4.builtin.join_multicast_group_timeout | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 5000 |
| Min-Max value | [0,UINT_MAX] |
| Tags | Transport Builtin Transport |
| dds.transport.UDPv4.builtin.multicast_enabled | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Allows the transport plugin to use multicast for sending and receiving. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><multicast_enabled> |
| dds.transport.UDPv4.builtin.multicast_loopback_disabled | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents the transport plugin from putting multicast packets onto the loopback interface. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><multicast_loopback_disabled> |
| dds.transport.UDPv4.builtin.multicast_ttl | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Min-Max value | [0,INT_MAX] |
| Description | Value for the time-to-live parameter for all multicast sends using this plugin. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><multicast_ttl> |
| dds.transport.UDPv4.builtin.no_zero_copy | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents the transport plugin from doing a zero copy. |
| Tags | Transport Builtin Transport |
| dds.transport.UDPv4.builtin.protocol_overhead_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 28 |
| Min-Max value | [0,UINT_MAX] |
| Description | Maximum size in bytes of protocol overhead, including headers. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><protocol_overhead_max> |
| dds.transport.UDPv4.builtin.public_address | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | Public IP address associated with the transport instantiation. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><disable_interface_tracking> |
| dds.transport.UDPv4.builtin.recv_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Size in bytes of the receive buffer of a socket used for receiving. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <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 | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Controls whether or not to reuse receive resources. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><reuse_multicast_receive_resource> |
| dds.transport.UDPv4.builtin.send_blocking | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Possible values | 0 1 2 |
| Description | Controls the blocking behavior of send sockets. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><send_blocking> |
| dds.transport.UDPv4.builtin.send_ping | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Min-Max value | [0,INT_MAX] |
| Description | This property specifies whether to send a PING message before commencing the discovery process. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><send_ping> |
| dds.transport.UDPv4.builtin.send_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Size in bytes of the send buffer of a socket used for sending. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><send_socket_buffer_size> |
| dds.transport.UDPv4.builtin.transport_priority_mapping_high | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0xFF |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the high value of the output range to IPv4 TOS. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><transport_priority_mapping_high> |
| dds.transport.UDPv4.builtin.transport_priority_mapping_low | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the low value of the output range to IPv4 TOS. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><transport_priority_mapping_low> |
| dds.transport.UDPv4.builtin.transport_priority_mask | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Mask for the transport priority field. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><transport_priority_mask> |
| dds.transport.UDPv4.builtin.unicast_enabled | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Allows the transport plugin to use unicast UDP for sending and receiving. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><unicast_enabled> |
| dds.transport.UDPv4.builtin.use_checksum | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Specifies whether the UDP checksum will be computed. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><use_checksum> |
parent¶
| dds.transport.UDPv4.builtin.parent.address_bit_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 32 |
| Min-Max value | [0,128] |
| Description | Number of bits in a 16-byte address that are used by the transport. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><address_bit_count> |
| dds.transport.UDPv4.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. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <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. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><allow_multicast_interfaces_list> |
| dds.transport.UDPv4.builtin.parent.deny_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. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <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. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <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 | 16 |
| Min-Max value | [0,INT_MAX] |
| Description | Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><gather_send_buffer_count_max> |
| dds.transport.UDPv4.builtin.parent.message_size_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 65507 |
| Min-Max value | [INT_MIN,MAX_INT] |
| Possible values | UDPV4_MESSAGE_SIZE_MAX_DEFAULT NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT |
| Description | The maximum size of a message in bytes that can be sent or received by the transport plugin. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><message_size_max> |
| dds.transport.UDPv4.builtin.parent.properties_bitmap | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | A bitmap that defines various properties of the transport to the Connext DDS core. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><properties_bitmap> |
UDPv6.builtin¶
| dds.transport.UDPv6.builtin.disable_interface_tracking | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Disables detection of network interface changes. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><disable_interface_tracking> |
| dds.transport.UDPv6.builtin.enable_v4mapped | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Specifies whether the UDPv6 transport will process IPv4 addresses. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><enable_v4mapped> |
| dds.transport.UDPv6.builtin.force_interface_poll_detection | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios. |
| Tags | Transport Builtin Transport |
| dds.transport.UDPv6.builtin.ignore_loopback_interface | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Possible values | -1 0 1 |
| Description | Prevents the transport plugin from using the IP loopback interface. |
| Tags | Transport Builtin Transport |
| dds.transport.UDPv6.builtin.ignore_nonrunning_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><ignore_nonrunning_interfaces> |
| dds.transport.UDPv6.builtin.interface_poll_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 500 |
| Min-Max value | [0,UINT_MAX] |
| Description | Specifies the period in milliseconds to query for changes in the state of all the interfaces. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><interface_poll_period> |
| dds.transport.UDPv6.builtin.join_multicast_group_timeout | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 5000 |
| Min-Max value | [0,UINT_MAX] |
| Tags | Transport Builtin Transport |
| dds.transport.UDPv6.builtin.multicast_enabled | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Allows the transport plugin to use multicast for sending and receiving. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><multicast_enabled> |
| dds.transport.UDPv6.builtin.multicast_loopback_disabled | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents the transport plugin from putting multicast packets onto the loopback interface. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><multicast_loopback_disabled> |
| dds.transport.UDPv6.builtin.multicast_ttl | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Min-Max value | [0,INT_MAX] |
| Description | Value for the time-to-live parameter for all multicast sends using this plugin. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><multicast_ttl> |
| dds.transport.UDPv6.builtin.no_zero_copy | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents the transport plugin from doing a zero copy. |
| Tags | Transport Builtin Transport |
| dds.transport.UDPv6.builtin.protocol_overhead_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 48 |
| Min-Max value | [0,UINT_MAX] |
| Description | Maximum size in bytes of protocol overhead, including headers. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><protocol_overhead_max> |
| dds.transport.UDPv6.builtin.public_address | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | Public IP address associated with the transport instantiation. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><public_address> |
| dds.transport.UDPv6.builtin.recv_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Size in bytes of the receive buffer of a socket used for receiving. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <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 | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Controls whether or not to reuse receive resources. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><reuse_multicast_receive_resource> |
| dds.transport.UDPv6.builtin.send_blocking | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Possible values | 0 1 2 |
| Description | Controls the blocking behavior of send sockets. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv4><send_blocking> |
| dds.transport.UDPv6.builtin.send_ping | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Min-Max value | [0,INT_MAX] |
| Description | This property specifies whether to send a PING message before commencing the discovery process. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><send_ping> |
| dds.transport.UDPv6.builtin.send_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [MIN_INT,MAX_INT] |
| Description | Size in bytes of the send buffer of a socket used for sending. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><send_socket_buffer_size> |
| dds.transport.UDPv6.builtin.transport_priority_mapping_high | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0xFF |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the high value of the output range to IPv4 TOS. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><transport_priority_mapping_high> |
| dds.transport.UDPv6.builtin.transport_priority_mapping_low | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the low value of the output range to IPv4 TOS. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><transport_priority_mapping_low> |
| dds.transport.UDPv6.builtin.transport_priority_mask | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Mask for the transport priority field. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><transport_priority_mask> |
| dds.transport.UDPv6.builtin.unicast_enabled | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Allows the transport plugin to use unicast UDP for sending and receiving. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><unicast_enabled> |
parent¶
| dds.transport.UDPv6.builtin.parent.address_bit_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 128 |
| Min-Max value | [0,128] |
| Description | Number of bits in a 16-byte address that are used by the transport. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><address_bit_count> |
| dds.transport.UDPv6.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. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <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. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><allow_multicast_interfaces_list> |
| dds.transport.UDPv6.builtin.parent.deny_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. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <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. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <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 | 16 |
| Min-Max value | [0,INT_MAX] |
| Description | Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><gather_send_buffer_count_max> |
| dds.transport.UDPv6.builtin.parent.message_size_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 65487 |
| Min-Max value | [INT_MIN,MAX_INT] |
| Possible values | UDPV4_MESSAGE_SIZE_MAX_DEFAULT NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT |
| Description | The maximum size of a message in bytes that can be sent or received by the transport plugin. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><message_size_max> |
| dds.transport.UDPv6.builtin.parent.properties_bitmap | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | A bitmap that defines various properties of the transport to the Connext DDS core. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><udpv6><properties_bitmap> |
WAN.wan1¶
| dds.transport.WAN.wan1.aliases | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .*[,.*]* |
| Description | Used to register the transport plugin returned by NDDS_Transport_WAN_create() (as specified by <WAN_prefix>.create_function) to the DomainParticipant. |
| Tags | Transport |
| dds.transport.WAN.wan1.create_function | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Must be ‘NDDS_Transport_WAN_create’. |
| Tags | Transport |
| dds.transport.WAN.wan1.dtls_connection_liveliness_interval | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 60 |
| Min-Max value | [0,UINT_MAX] |
| Description | Liveliness interval (multiple of resend interval) |
| Tags | Transport |
| dds.transport.WAN.wan1.dtls_handshake_resend_interval | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 1000 |
| Min-Max value | [0,UINT_MAX] |
| Description | DTLS handshake retransmission interval in milliseconds. |
| Tags | Transport |
| dds.transport.WAN.wan1.enable_security | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Possible values | 0 1 |
| Description | Required if you want to use security. |
| Tags | Transport |
| dds.transport.WAN.wan1.interface_address | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | Locator, as a string |
| Tags | Transport |
| dds.transport.WAN.wan1.library | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Must set to ‘libnddstransportwan.so’ (for UNIX/Solaris systems) or ‘nddstransportwan.dll’ (for Windows system). |
| Tags | Transport |
| dds.transport.WAN.wan1.port_offset | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 144 |
| Min-Max value | [0,INT_MAX] |
| Description | Port offset to allow coexistence with non-secure UDP transport. |
| Tags | Transport |
| dds.transport.WAN.wan1.recv_decode_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 65507 |
| Min-Max value | [0,INT_MAX] |
| Description | Size of buffer for decoding packets from wire. |
| Tags | Transport |
| dds.transport.WAN.wan1.security_verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [-1,INT_MAX] |
| Description | Specifies the verbosity of security-related log messages from the transport. |
| Tags | Transport Transport Secure Logging |
| dds.transport.WAN.wan1.server | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | Server locator, as a string. |
| Tags | Transport |
| dds.transport.WAN.wan1.server_port | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 3478 |
| Min-Max value | [0,UINT_MAX] |
| Description | Server port number. |
| Tags | Transport |
| dds.transport.WAN.wan1.stun_liveliness_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 15000 |
| Min-Max value | [0,UINT_MAX] |
| Description | Period at which messages are sent to peers to keep NAT holes open. |
| Tags | Transport |
| dds.transport.WAN.wan1.stun_number_of_retransmissions | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 7 |
| Min-Max value | [0,UINT_MAX] |
| Description | Maximum number of times STUN messages are resent unless a response is received. |
| Tags | Transport |
| dds.transport.WAN.wan1.stun_retransmission_interval | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 100 |
| Min-Max value | [0,UINT_MAX] |
| Description | STUN request messages requiring a response are resent with this interval. |
| Tags | Transport |
| dds.transport.WAN.wan1.transport_instance_id | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | {0,0,0,0,0,0,0,0,0,0,0,0} |
| Min-Max value | [0,0xef] |
| Description | A set of comma-separated values to specify the elements of the array. |
| Tags | Transport |
| dds.transport.WAN.wan1.verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [-1,INT_MAX] |
| Description | Specifies the verbosity of log messages from the transport. |
| Tags | Transport Logging |
parent¶
| dds.transport.WAN.wan1.parent.ignore_loopback_interface | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Possible values | -1 0 1 |
| Description | Prevents the transport plugin from using the IP loopback interface. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.ignore_nonrunning_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Possible values | 0 1 |
| Description | Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.no_zero_copy | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Possible values | 0 1 |
| Description | Prevents the transport plugin from doing a zero copy. |
| Tags | Transport |
| The property has been deprecated in version | 6.0.0 |
| dds.transport.WAN.wan1.parent.recv_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [0,INT_MAX] |
| Description | Size in bytes of the receive buffer of a socket used for receiving. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.send_blocking | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Possible values | 0 1 2 |
| Description | Controls the blocking behavior of send sockets. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.send_socket_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 131072 |
| Min-Max value | [0,INT_MAX] |
| Description | Size in bytes of the send buffer of a socket used for sending. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.transport_priority_mapping_high | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0xFF |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the high value of the output range to IPv4 TOS. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.transport_priority_mapping_low | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Sets the low value of the output range to IPv4 TOS. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.transport_priority_mask | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Mask for the transport priority field. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.unicast_enabled | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Possible values | 0 1 |
| Description | Allows the transport plugin to use unicast UDP for sending and receiving. |
| Tags | Transport |
parent.parent¶
| dds.transport.WAN.wan1.parent.parent.address_bit_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 128 |
| Min-Max value | [0,128] |
| Description | Number of bits in a 16-byte address that are used by the transport. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.parent.allow_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .*(,.*)* |
| Description | A list of strings, each identifying a range of interface addresses. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.parent.deny_interfaces | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .*(,.*)* |
| Description | A list of strings, each identifying a range of interface addresses |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.parent.gather_send_buffer_count_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 16 |
| Min-Max value | [0,INT_MAX] |
| Description | Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.parent.message_size_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 65507 |
| Min-Max value | [0,INT_MAX] |
| Description | The maximum size of a message in bytes that can be sent or received by the transport plugin. |
| Tags | Transport |
| dds.transport.WAN.wan1.parent.parent.properties_bitmap | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | A bitmap that defines various properties of the transport to the Connext DDS core. |
| Tags | Transport |
tls.cipher¶
| dds.transport.WAN.wan1.tls.cipher.cipher_list | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | List of available (D)TLS ciphers. |
| Tags | Transport Transport Secure |
| dds.transport.WAN.wan1.tls.cipher.dh_param_files | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | (.+:[0-9]+)(,.+:[0-9]+).* |
| Description | List of available Diffie-Hellman (DH) key files. |
| Tags | Transport Transport Secure |
| dds.transport.WAN.wan1.tls.cipher.engine_id | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | ID of OpenSSL cipher engine to request. |
| Tags | Transport Transport Secure |
tls.identity¶
| dds.transport.WAN.wan1.tls.identity.certificate_chain_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the name of a file containing an identifying certificate chain (in PEM format). |
| Tags | Transport Transport Secure |
| dds.transport.WAN.wan1.tls.identity.private_key_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | File containing private key (in PEM format). |
| Tags | Transport Transport Secure |
| dds.transport.WAN.wan1.tls.identity.private_key_password | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the password for the private key. |
| Tags | Transport Transport Secure |
| dds.transport.WAN.wan1.tls.identity.rsa_private_key_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | File containing additional RSA private key (in PEM format). |
| Tags | Transport Transport Secure |
tls.verify¶
| dds.transport.WAN.wan1.tls.verify.ca_file | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies the name of a file containing Certificate Authority certificates. |
| Tags | Transport Transport Secure |
| dds.transport.WAN.wan1.tls.verify.ca_path | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | A string that specifies paths to directories containing Certificate Authority certificates. |
| Tags | Transport Transport Secure |
| dds.transport.WAN.wan1.tls.verify.callback | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | NULL |
| Possible values | default verbose none |
| Description | NDDS_Transport_TLS_default_verify_callback() |
| Tags | Transport Transport Secure |
| dds.transport.WAN.wan1.tls.verify.verify_depth | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [INT_MIN,INT_MAX] |
| Description | Maximum certificate chain length for verification. |
| Tags | Transport Transport Secure |
| dds.transport.WAN.wan1.tls.verify.verify_peer | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | If non-zero, use mutual authentication when performing TLS handshake (default). |
| Tags | Transport Transport Secure |
lbrtps¶
| dds.transport.lbrtps.aliases | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .*[,.*]* |
| Description | Aliases used to register the LBRTPS transport plugin with the DomainParticipant. |
| Tags | Transport |
| dds.transport.lbrtps.create_function | |
| 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. |
| Tags | Transport |
| dds.transport.lbrtps.library | |
| 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. |
| Tags | Transport |
| dds.transport.lbrtps.subtransport | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | [UDPv4\|zrtps\|.*] |
| Description | Name of the plugin to be loaded by the LBRTPS transport. |
| Tags | Transport |
| dds.transport.lbrtps.verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Possible values | -1 0 2 |
| Description | The verbosity for the plugin, for debugging purposes. |
| Tags | Transport Logging |
rtps_header¶
| dds.transport.lbrtps.rtps_header.eliminate_protocol | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Whether or not to eliminate the 4-byte protocol field in the RTPS header. |
| Tags | Transport |
| dds.transport.lbrtps.rtps_header.eliminate_vendorId | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Whether or not to eliminate the 2-byte vendorId field in the RTPS header. |
| Tags | Transport |
| dds.transport.lbrtps.rtps_header.eliminate_version | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Whether or not to eliminate the 2-byte version field in the RTPS header. |
| Tags | Transport |
| dds.transport.lbrtps.rtps_header.reduce_guidPrefix | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | 32,32,32 |
| Min-Max value | [0,32] |
| Description | The reduce_guidPrefix field is composed of 12 bytes that represent 3 different fields of 4 bytes each: hostId, appId and instanceId. |
| Tags | Transport |
submessage_header¶
| dds.transport.lbrtps.submessage_header.combine_submessageId_with_flags | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Combine the first two fields in the SubmessageHeader; do not use all the bits. |
| Tags | Transport |
submessages¶
| dds.transport.lbrtps.submessages.reduce_entitiesId | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | 32,32 |
| Min-Max value | [8,32] |
| 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. |
| Tags | Transport |
| dds.transport.lbrtps.submessages.reduce_sequenceNumber | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 64 |
| Min-Max value | [16,64] |
| 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. |
| Tags | Transport |
shmem.builtin¶
| dds.transport.shmem.builtin.enable_udp_debugging | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Enables UDP debugging when using shared memory. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><enable_udp_debugging> |
| dds.transport.shmem.builtin.host_id | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 0 |
| Min-Max value | [0,UINT_MAX] |
| Description | Host ID used to generate the shared memory transport network address. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><host_id> |
| dds.transport.shmem.builtin.receive_buffer_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1048576 |
| Min-Max value | [0,INT_MAX] |
| Description | The total number of bytes that can be buffered in the receive queue. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><receive_buffer_size> |
| dds.transport.shmem.builtin.received_message_count_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 64 |
| Min-Max value | [0,INT_MAX] |
| Description | Number of messages that can be buffered in the receive queue. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><received_message_count_max> |
| dds.transport.shmem.builtin.udp_debugging_address | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | 239.255.1.2 |
| Min-Max value | [0,255] |
| Description | IP address to which shared memory traffic will be published |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><udp_debugging_address> |
| dds.transport.shmem.builtin.udp_debugging_port | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | unsigned integer |
| Default Value | 7399 |
| Min-Max value | [0,UINT_MAX] |
| Description | Port to which shared memory traffic will be published. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><udp_debugging_port> |
| dds.transport.shmem.builtin.use_530_from_uuid_locator | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | This property only applies when the WireProtocol QoS policy (specifically rtps_auto_id_kind) is set to DDS_RTPS_AUTO_ID_FROM_UUID. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><use_530_from_uuid_locator> |
parent¶
| dds.transport.shmem.builtin.parent.address_bit_count | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 32 |
| Min-Max value | [0,128] |
| Description | Number of bits in a 16-byte address that are used by the transport. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><address_bit_count> |
| dds.transport.shmem.builtin.parent.gather_send_buffer_count_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><gather_send_buffer_count_max> |
| dds.transport.shmem.builtin.parent.message_size_max | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 65536 |
| Min-Max value | [INT_MIN,INT_MAX] |
| Description | The maximum size of a message in bytes that can be sent or received by the transport plugin. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><message_size_max> |
| dds.transport.shmem.builtin.parent.properties_bitmap | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0x2 |
| Min-Max value | [0,INT_MAX] |
| Description | A bitmap that defines various properties of the transport to the Connext DDS core. |
| Tags | Transport Builtin Transport |
| The property has been promoted to | <participant_qos><transport_builtin><shmem><properties_bitmap> |
zrtps¶
| dds.transport.zrtps.aliases | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .*[,.*]* |
| Tags | Transport |
| dds.transport.zrtps.compression_level | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 9 |
| Min-Max value | [1,9] |
| Description | Defines the compression level that the compression algorithm will use for all RTPS packages. |
| Tags | Transport |
| dds.transport.zrtps.compression_library | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | ZLIB_COMPRESSION |
| Possible values | BZIP2_COMPRESSION EXTERNAL_COMPRESSION AUTOMATIC_COMPRESSION ZLIB_COMPRESSION |
| Description | Aliases used to register the ZRTPS transport plugin with the DomainParticipant. |
| Tags | Transport |
| dds.transport.zrtps.create_function | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | Must be set to ZRTPS_Transport_create_plugin. |
| Tags | Transport |
| dds.transport.zrtps.external_library | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | Sets the name of a user’s external library that is to be located and used by the ZRTPS transport plugin. |
| Tags | Transport |
| dds.transport.zrtps.high_mark | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 512 |
| Min-Max value | [0,INT_MAX] |
| Description | Specifies the size for small, medium, and large RTPS packages. |
| Tags | Transport |
| dds.transport.zrtps.library | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .* |
| Description | The value must be rtizrtps. |
| Tags | Transport |
| dds.transport.zrtps.low_mark | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 128 |
| Min-Max value | [0,INT_MAX] |
| Description | Specifies the size for small, medium, and large RTPS packages. |
| Tags | Transport |
| dds.transport.zrtps.subtransport | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Pattern value | .*\|UDPv4 |
| 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>. |
| Tags | Transport |
| dds.transport.zrtps.verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [INT_MIN,INT_MAX] |
| Description | The verbosity for the plugin, for debugging purposes. |
| Tags | Transport |
compression_level¶
| dds.transport.zrtps.compression_level.large_packets | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 9 |
| Min-Max value | [1,9] |
| Description | Defines the compression level that the compression algorithm will use for large RTPS packages. |
| Tags | Transport |
| dds.transport.zrtps.compression_level.medium_packets | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 9 |
| Min-Max value | [1,9] |
| Description | Defines the compression level that the compression algorithm will use for medium RTPS packages. |
| Tags | Transport |
| dds.transport.zrtps.compression_level.small_packets | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 9 |
| Min-Max value | [1,9] |
| Description | Defines the compression level that the compression algorithm will use for small RTPS packages. |
| Tags | Transport |
compression_library¶
| dds.transport.zrtps.compression_library.large_packets | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | ZLIB_COMPRESSION |
| Possible values | BZIP2_COMPRESSION EXTERNAL_COMPRESSION AUTOMATIC_COMPRESSION ZLIB_COMPRESSION |
| Description | Specifies the compression algorithm to be used for large RTPS packages. |
| Tags | Transport |
| dds.transport.zrtps.compression_library.medium_packets | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | ZLIB_COMPRESSION |
| Possible values | BZIP2_COMPRESSION EXTERNAL_COMPRESSION AUTOMATIC_COMPRESSION ZLIB_COMPRESSION |
| Description | Specifies the compression algorithm to be used for medium RTPS packages. |
| Tags | Transport |
| dds.transport.zrtps.compression_library.small_packets | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | enum |
| Default Value | ZLIB_COMPRESSION |
| Possible values | BZIP2_COMPRESSION EXTERNAL_COMPRESSION AUTOMATIC_COMPRESSION ZLIB_COMPRESSION |
| Description | Specifies the compression algorithm to be used for small RTPS packages. |
| Tags | Transport |
rti.monitor¶
| rti.monitor.create_function | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | RTIDefaultMonitor_create |
| Tags | Monitor |
| rti.monitor.create_function_ptr | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | pointer |
| Default Value | NULL |
| Tags | Monitor |
| rti.monitor.library | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| Pattern value | rtimonitoring |
| Tags | Monitor |
config¶
| rti.monitor.config.get_process_statistics | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | true false |
| 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. |
| Tags | Monitor |
| rti.monitor.config.new_participant_domain_id | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [0,255] |
| 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. |
| Tags | Monitor |
| rti.monitor.config.publish_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 5 |
| Min-Max value | [0,INT_MAX] |
| Description | Period of time to sample and publish all monitoring topics, in units of seconds. |
| Tags | Monitor |
| rti.monitor.config.publish_thread_options | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | mask |
| Default Value | FLOATING_POINT \| STDIO |
| Possible values | STDIO FLOATING_POINT REALTIME_PRIORITY PRIORITY_ENFORCE |
| Description | Describes the type of thread. |
| Tags | Monitor |
| rti.monitor.config.publish_thread_priority | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | RTI_OSAPI_THREAD_PRIORITY_BELOW_NORMAL |
| Description | Priority of the thread used to sample and publish monitoring data. |
| Tags | Monitor |
| rti.monitor.config.publish_thread_stacksize | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | RTI_OSAPI_THREAD_STACK_SIZE_DEFAULT |
| Description | Stack size used for the thread that samples and publishes monitoring data. |
| Tags | Monitor |
| rti.monitor.config.qos_library | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| 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). |
| Tags | Monitor |
| rti.monitor.config.qos_profile | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| 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). |
| Tags | Monitor |
| rti.monitor.config.reset_status_change_counts | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | true false |
| 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. |
| Tags | Monitor |
| rti.monitor.config.skip_monitor_entities | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | true |
| Possible values | true false |
| 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. |
| Tags | Monitor |
| rti.monitor.config.skip_participant_properties | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | true false |
| Description | If set to true, DomainParticipant PropertyQosPolicy name and value pairs will not be sent out through the domainParticipantDescriptionTopic. |
| Tags | Monitor |
| rti.monitor.config.skip_reader_properties | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | true false |
| Tags | Monitor |
| rti.monitor.config.skip_writer_properties | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | boolean |
| Default Value | false |
| Possible values | true false |
| Description | If set to true, DataReader PropertyQosPolicy name and value pairs will not be sent out through the dataReaderDescriptionTopic. |
| Tags | Monitor |
| rti.monitor.config.topics | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| 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). |
| Tags | Monitor |
| rti.monitor.config.usertopics | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | string |
| Default Value | NULL |
| 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). |
| Tags | Monitor |
| rti.monitor.config.verbosity | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | 1 |
| Min-Max value | [-1,INT_MAX] |
| Description | Sets the verbosity on the monitoring library for debugging purposes. |
| Tags | Monitor Logging |
| rti.monitor.config.writer_pool_buffer_max_size | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [-1,INT_MAX] |
| Description | Controls the threshold at which dynamic memory allocation is used, expressed as a number of bytes. |
| Tags | Monitor |
DataWriter¶
dds.builtin_type.keyed_octets¶
| dds.builtin_type.keyed_octets.alloc_key_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the key published by the DataWriter or received by the DataReader (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_octets.alloc_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 2048 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the octet sequences published by the DataWriter or DataReader. |
| Tags | Builtin Type |
| dds.builtin_type.keyed_octets.max_key_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the key published by the DataWriter and received by the DataReaders belonging to the DomainParticipant (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_octets.max_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 2048 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the octet sequences published by the DataWriters and DataReaders belonging to a DomainParticipant. |
| Tags | Builtin Type |
dds.builtin_type.keyed_string¶
| dds.builtin_type.keyed_string.alloc_key_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the keys used by the DataWriter or DataReader (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_string.alloc_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the strings published by the DataWriter or received by the DataReader (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_string.max_key_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the keys used by the DataWriters and DataReaders belonging to a DomainParticipant (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_string.max_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| 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). |
| Tags | Builtin Type |
dds.builtin_type.octets¶
| dds.builtin_type.octets.alloc_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 2048 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the octet sequences published by the DataWriter or DataReader. |
| Tags | Builtin Type |
| dds.builtin_type.octets.max_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 2048 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the octet sequences published by the DataWriters and DataReaders belonging to a DomainParticipant. |
| Tags | Builtin Type |
dds.builtin_type.string¶
| dds.builtin_type.string.alloc_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the strings published by the DataWriter or received by the DataReader (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.string.max_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the strings published by the DataWriters and received by the DataReaders belonging to a DomainParticipant (includes the NULL-terminated character). |
| Tags | Builtin Type |
dds.data_reader¶
| dds.data_reader.shared_subscriber_name | |
| May be set in | DataWriter DataReader |
| Applies to | DataWriter DataReader |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | The DataReader must attach to the SharedSubscriber that contains the SharedReaderQueue. |
| Tags | Other |
dds.data_writer¶
| dds.data_writer.enable_turbo_mode | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Enables Turbo Mode and adjusts the batch max_data_bytes based on how frequently the DataWriter writes data. |
| Tags | Batching Reliability |
auto_throttle¶
| dds.data_writer.auto_throttle.enable | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Enables automatic throttling in the DataWriter. |
| Tags | Reliability |
history¶
| dds.data_writer.history.key_material_key | |
| May be set in | DataWriter DomainParticipant |
| Applies to | DataWriter |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | The basis of the key material used to encrypt the PRSTDataWriter’s key material. |
| Tags | Durability DDS Secure |
| dds.data_writer.history.plugin_name | |
| May be set in | DataWriter DomainParticipant |
| Applies to | DataWriter |
| Type | string |
| Default Value | dds.data_writer.history.odbc_plugin.builtin |
| Pattern value | dds.data_writer.history.odbc_plugin.builtin |
| Description | Must be set to ‘dds.data_writer.history.odbc_plugin.builtin’ to enable durable writer history in the DataWriter. |
| Tags | Durability |
| dds.data_writer.history.purge_samples_after_acknowledgment | |
| May be set in | DataWriter DomainParticipant |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | The DataWriter’s behavior can be changed to purge DDS samples after they have been acknowledged by all the active/matching DataReaders. |
| Tags | Durability |
| dds.data_writer.history.source_timestamp_based_autopurge_instances_delay | |
| May be set in | DataWriter DomainParticipant |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| 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. |
| Tags | Durability Instance |
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 | -1 |
| Min-Max value | [-1,INT_MAX] |
| Description | Controls the memory allocation for the serialized sample. |
| Tags | Queue Memory Management |
memory_manager.java_stream¶
| dds.data_writer.history.memory_manager.java_stream.min_size | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | integer |
| Default Value | Max Serialized Sample Size |
| Min-Max value | [0,INT_MAX] |
| Description | Defines the minimum size of the buffer that will be used to serialize DDS samples. |
| Tags | 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 | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | A boolean value that controls the growth of the serialization buffer. |
| Tags | Queue Memory Management |
odbc_plugin¶
| dds.data_writer.history.odbc_plugin.driver | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | string |
| Default Value | "libodbc.so" (Unix) "odbc32.dll" (Windows) |
| Pattern value | ^.{0,30}$ |
| Description | Tells Connext DDS which ODBC driver to load. |
| Tags | Durability |
| dds.data_writer.history.odbc_plugin.dsn | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | string |
| Pattern value | ^.{1,512}$ |
| Description | The ODBC DSN (Data Source Name) associated with the database where the writer history must be persisted. |
| Tags | Durability |
| dds.data_writer.history.odbc_plugin.in_memory_state | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Determines how much state will be kept in memory by the ODBC writer history in order to avoid accessing the database. |
| Tags | Durability |
| dds.data_writer.history.odbc_plugin.instance_cache_init_size | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | integer |
| Min-Max value | [0,INT_MAX] |
| Description | Configures the resource limits associated with the ODBC writer history caches. |
| Tags | Durability Instance |
| dds.data_writer.history.odbc_plugin.instance_cache_max_size | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [-1,INT_MAX] |
| Description | Configures the resource limits associated with the ODBC writer history caches. |
| Tags | Durability Instance |
| dds.data_writer.history.odbc_plugin.password | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | string |
| Pattern value | ^.{0,30}$ |
| Description | Configures the password used to connect to the database. |
| Tags | Durability |
| dds.data_writer.history.odbc_plugin.restore | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Indicates whether or not the persisted writer history must be restored once the DataWriter is restarted. |
| Tags | Durability |
| dds.data_writer.history.odbc_plugin.sample_cache_init_size | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | integer |
| Default Value | 32 |
| Min-Max value | [1,INT_MAX] |
| Description | Configures the resource limits associated with the ODBC writer history caches. |
| Tags | Durability |
| dds.data_writer.history.odbc_plugin.sample_cache_max_size | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | integer |
| Default Value | 32 |
| Min-Max value | [-1,INT_MAX] |
| Description | Configure the resource limits associated with the ODBC writer history caches. |
| Tags | Durability |
| dds.data_writer.history.odbc_plugin.shared | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Creates a single connection per DSN that will be shared across DataWriters within the same Publisher. |
| Tags | Durability |
| dds.data_writer.history.odbc_plugin.username | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | string |
| Pattern value | ^.{0,30}$ |
| Description | Configures the username used to connect to the database. |
| Tags | Durability |
protocol¶
| dds.data_writer.protocol.disable_repair_piggyback_heartbeat | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents piggyback HBs from being sent with repair samples |
| Tags | Reliability |
| dds.data_writer.protocol.multicast_repair_threshold | |
| May be set in | DataWriter |
| Applies to | DataWriter |
| Type | integer |
| Default Value | 2 |
| Min-Max value | [0,INT_MAX] |
| Description | Support for Periodic heartbeats (HBs) over multicast. |
| Tags | Reliability |
| dds.data_writer.protocol.send_multicast_periodic_heartbeats | |
| May be set in | DataWriter DomainParticipant |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Support for periodic heartbeats (HBs) over multicast. |
| Tags | Reliability |
| dds.data_writer.protocol.use_43_large_data_format | |
| May be set in | DataWriter DomainParticipant |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Achieve backward compatibility sending ‘Large Data’ between RTI Data Distribution Service 4.4d and older Releases. |
| Tags | Reliability Type System |
reliability¶
| dds.data_writer.reliability.delegate_reliability | |
| May be set in | DataWriter DomainParticipant |
| Applies to | DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Delegates the reliability task to a separate service. |
| Tags | Reliability |
type_support¶
| dds.data_writer.type_support.cdr_string_encoding_kind | |
| May be set in | DataWriter DomainParticipant |
| Applies to | DataWriter |
| Type | enum |
| Default Value | UTF-8 |
| Possible values | UTF-8 ISO-8859-1 |
| Description | Configures the IDL wire string encoding. |
| Tags | Type System |
dds.domain_participant.auto_throttle¶
| dds.domain_participant.auto_throttle.enable | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Configures the DomainParticipant to gather internal measurements (during DomainParticipant creation) that are required for the Auto Throttle feature. |
| Tags | 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 DataWriter |
| Type | enum |
| Default Value | DDS_EDF_FLOW_CONTROLLER_SCHED_POLICY |
| Possible values | DDS_RR_FLOW_CONTROLLER_SCHED_POLICY DDS_EDF_FLOW_CONTROLLER_SCHED_POLICY DDS_HPF_FLOW_CONTROLLER_SCHED_POLICY |
| Description | Specifies the scheduling policy to be used. |
| Tags | 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 DataWriter |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum number of bytes allowed to send for each token available. |
| Tags | Flow Controller |
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.max_tokens | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum number of tokens than can accumulate in the token bucket. |
| Tags | Flow Controller |
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.tokens_added_per_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | integer |
| Default Value | -1 |
| Min-Max value | [-1,INT_MAX] |
| Description | Number of tokens added to the token bucket per specified period. |
| Tags | Flow Controller |
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.tokens_leaked_per_period | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Number of tokens removed from the token bucket per specified period. |
| Tags | Flow Controller |
period¶
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.period.nanosec | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | unsigned integer |
| Default Value | 0 |
| Min-Max value | [0,UINT_MAX] |
| Description | Period for adding tokens to and removing tokens from the bucket in nanoseconds. |
| Tags | Flow Controller |
| dds.flow_controller.token_bucket.<flow_controller_name>.token_bucket.period.sec | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | integer |
| Default Value | 1 |
| Min-Max value | [0,INT_MAX] |
| Description | Period for adding tokens to and removing tokens from the bucket in seconds. |
| Tags | Flow Controller |
dds.participant.builtin_data_writer.protocol¶
| dds.participant.builtin_data_writer.protocol.disable_repair_piggyback_heartbeat | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Prevents piggyback HBs from being sent with repair samples for builtin discovery topics |
| Tags | Reliability |
dds.participant.discovery_config¶
| dds.participant.discovery_config.disable_endpoint_security_info_propagation | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Participant may communicate for some combinations of inconsistent metadata/data protection kinds. |
| Tags | Discovery |
dds.participant.inter_participant_data_writer.protocol¶
| dds.participant.inter_participant_data_writer.protocol.disable_preemptive_heartbeat | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Disable preemptive Heartbeats and NACKs. |
| Tags | Discovery Reliability |
dds.sample_assignability¶
| dds.sample_assignability.accept_unknown_enum_value | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | When set to 1, samples containing an unknown enumerator can be successfully deserialized to the default enumeration value. |
| Tags | Type System |
| dds.sample_assignability.accept_unknown_union_discriminator | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | When set to 1, samples containing an unknown union discriminator can be successfully deserialized to the default discriminator value. |
| Tags | Type System |
dds.type_consistency¶
| dds.type_consistency.ignore_member_names | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Controls whether member names are taken into consideration for type assignability. |
| Tags | Type System |
| The property has been deprecated by | <datareader_qos><type_consistency><ignore_member_names> |
| dds.type_consistency.ignore_sequence_bounds | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Controls whether sequence bounds are taken into consideration for type assignability. |
| Tags | Type System |
| The property has been deprecated by | <datareader_qos><type_consistency><ignore_sequence_bounds> |
DataReader¶
dds.builtin_type.keyed_octets¶
| dds.builtin_type.keyed_octets.alloc_key_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the key published by the DataWriter or received by the DataReader (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_octets.alloc_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 2048 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the octet sequences published by the DataWriter or DataReader. |
| Tags | Builtin Type |
| dds.builtin_type.keyed_octets.max_key_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the key published by the DataWriter and received by the DataReaders belonging to the DomainParticipant (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_octets.max_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 2048 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the octet sequences published by the DataWriters and DataReaders belonging to a DomainParticipant. |
| Tags | Builtin Type |
dds.builtin_type.keyed_string¶
| dds.builtin_type.keyed_string.alloc_key_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the keys used by the DataWriter or DataReader (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_string.alloc_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the strings published by the DataWriter or received by the DataReader (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_string.max_key_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the keys used by the DataWriters and DataReaders belonging to a DomainParticipant (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.keyed_string.max_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| 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). |
| Tags | Builtin Type |
dds.builtin_type.octets¶
| dds.builtin_type.octets.alloc_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 2048 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the octet sequences published by the DataWriter or DataReader. |
| Tags | Builtin Type |
| dds.builtin_type.octets.max_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 2048 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the octet sequences published by the DataWriters and DataReaders belonging to a DomainParticipant. |
| Tags | Builtin Type |
dds.builtin_type.string¶
| dds.builtin_type.string.alloc_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the strings published by the DataWriter or received by the DataReader (includes the NULL-terminated character). |
| Tags | Builtin Type |
| dds.builtin_type.string.max_size | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | integer |
| Default Value | 1024 |
| Min-Max value | [0,INT_MAX] |
| Description | Maximum size of the strings published by the DataWriters and received by the DataReaders belonging to a DomainParticipant (includes the NULL-terminated character). |
| Tags | Builtin Type |
dds.data_reader¶
| dds.data_reader.shared_subscriber_name | |
| May be set in | DataWriter DataReader |
| Applies to | DataWriter DataReader |
| Type | string |
| Default Value | NULL |
| Pattern value | .* |
| Description | The DataReader must attach to the SharedSubscriber that contains the SharedReaderQueue. |
| Tags | 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 | -1 |
| Min-Max value | [-1,INT_MAX] |
| Description | Controls the memory allocation for serialization. |
| Tags | Queue Memory Management |
history.memory_manager.java_stream¶
| dds.data_reader.history.memory_manager.java_stream.min_size | |
| May be set in | DataReader |
| Applies to | DataReader |
| Type | integer |
| Default Value | Max Serialized Sample Size |
| Min-Max value | [0,INT_MAX] |
| Description | Defines the minimum size of the buffer used for the serialized data. |
| Tags | 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 | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | A Boolean value that controls the growth of the deserialization buffer. |
| Tags | Queue Memory Management |
protocol¶
| dds.data_reader.protocol.use_43_large_data_format | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Achieve backward compatibility sending ‘Large Data’ between RTI Data Distribution Service 4.4d and older Releases. |
| Tags | Reliability Type System |
reliability¶
| dds.data_reader.reliability.delegate_reliability | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Delegates the reliability task to a separate service. |
| Tags | Reliability |
state¶
| dds.data_reader.state.checkpoint_frequency | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Controls how often the DataReader state is stored into the database. |
| Tags | Durability |
| dds.data_reader.state.filter_redundant_samples | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Enables durable DataReader state. |
| Tags | Durability Filtering |
| dds.data_reader.state.restore | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | boolean |
| Default Value | true |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Indicates if the persisted DataReader state must be restored or not once the DataReader is restarted. |
| Tags | Durability |
odbc¶
| dds.data_reader.state.odbc.driver | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | string |
| Default Value | odbc32.dll (Windows) libodbc.so (Otherwise) |
| Pattern value | .* |
| Description | Indicates which ODBC driver to load. |
| Tags | Durability |
| dds.data_reader.state.odbc.dsn | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | string |
| Pattern value | ^.{1,512}$ |
| Description | The ODBC DSN (Data Source Name) associated with the database where the DataReader state must be persisted. |
| Tags | Durability |
| dds.data_reader.state.odbc.password | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | string |
| Pattern value | ^.{0,30}$ |
| Description | Configures the password used to connect to the database. |
| Tags | Durability |
| dds.data_reader.state.odbc.username | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | string |
| Pattern value | ^.{0,30}$ |
| Description | Configures the username used to connect to the database. |
| Tags | Durability |
persistence_service¶
| dds.data_reader.state.persistence_service.request_depth | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | integer |
| Default Value | 0 |
| Min-Max value | [0,INT_MAX] |
| Description | Indicates how many of the most recent historical samples the persisted DataReader wants to receive upon start-up. |
| Tags | Durability |
type_support¶
| dds.data_reader.type_support.cdr_string_encoding_kind | |
| May be set in | DataReader DomainParticipant |
| Applies to | DataReader |
| Type | enum |
| Default Value | UTF-8 |
| Possible values | UTF-8 ISO-8859-1 |
| Description | Configures the IDL wire string encoding. |
| Tags | Type System |
dds.participant.discovery_config¶
| dds.participant.discovery_config.disable_endpoint_security_info_propagation | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Participant may communicate for some combinations of inconsistent metadata/data protection kinds. |
| Tags | Discovery |
dds.participant.inter_participant_data_reader.protocol¶
| dds.participant.inter_participant_data_reader.protocol.disable_preemptive_nack | |
| May be set in | DomainParticipant |
| Applies to | DomainParticipant DataReader |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Disable preemptive Heartbeats and NACKs. |
| Tags | Discovery Reliability |
dds.sample_assignability¶
| dds.sample_assignability.accept_unknown_enum_value | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | When set to 1, samples containing an unknown enumerator can be successfully deserialized to the default enumeration value. |
| Tags | Type System |
| dds.sample_assignability.accept_unknown_union_discriminator | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | When set to 1, samples containing an unknown union discriminator can be successfully deserialized to the default discriminator value. |
| Tags | Type System |
dds.type_consistency¶
| dds.type_consistency.ignore_member_names | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Controls whether member names are taken into consideration for type assignability. |
| Tags | Type System |
| The property has been deprecated by | <datareader_qos><type_consistency><ignore_member_names> |
| dds.type_consistency.ignore_sequence_bounds | |
| May be set in | DataReader DataWriter DomainParticipant |
| Applies to | DataReader DataWriter |
| Type | boolean |
| Default Value | false |
| Possible values | 0 1 TRUE FALSE YES NO |
| Description | Controls whether sequence bounds are taken into consideration for type assignability. |
| Tags | Type System |
| The property has been deprecated by | <datareader_qos><type_consistency><ignore_sequence_bounds> |