.. |br| raw:: html
.. _section-property_entity:
List of Properties by Entity
****************************
DomainParticipant
+++++++++++++++++
com.rti.serv
------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|`com.rti.serv.load_plugin `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Type |string |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Mutability type |immutable |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Description |The prefix name of the security plugin suite that will be loaded by Connext DDS. |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
secure
^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.create_function `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Description |Must be set to the security plugin suite creation function that is implemented by the library. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|`com.rti.serv.secure.create_function_ptr `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Mutability type |immutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Description |Must be set to the security plugin suite creation function implemented by the library.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|`com.rti.serv.secure.library `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Mutability type |immutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Description |Must be set to the dynamic library that implements the security plugin suite. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.license_file `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Description |The value for this property can be set to the location (full path and filename) of a license file.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|`com.rti.serv.secure.license_string `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Mutability type |immutable |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Description |The value for this property can be set to the content of a license file.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.openssl_engine `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |A semicolon-separated list of dynamic libraries that each implement an OpenSSL engine. Each engine may implement a different set of security functions. For example, one engine may implement certificate management, while another engine may implement cryptographic operations. If the authentication.keyform property value is engine, then the private key must be successfully loaded by exactly one of the engines in this list.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.property_validation_action `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`VALIDATION_ACTION_EXCEPTION` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`VALIDATION_ACTION_WARNING` |br|\ :code:`VALIDATION_ACTION_EXCEPTION` |br|\ :code:`VALIDATION_ACTION_SKIP` |br|\ :code:`-1` |br|\ :code:`0` |br|\ :code:`1` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |configures the validation of the properties. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
access_control
""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|`com.rti.serv.secure.access_control.alternative_permissions_authority_files `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Mutability type |immutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Pattern value |:code:`.*(,.*)*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Description |A comma-separated list of alternative Permissions CA certificates.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.access_control.use_530_logging_protection `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |How to set the value of for the Builtin Logging Topic. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.access_control.use_530_partitions `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|Description |How to determine a match between a DataWriter's or DataReader's partitions and an 'allowed partitions' condition in a Permissions Document.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.access_control.use_530_permissions_rules_precedence `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|Description |How to deal with conflicting allow/deny rules in a Permissions Document when checking if a topic or endpoint may exist.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.access_control.use_610_permissions_rules_precedence `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`auto` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ :code:`AUTO` |br|\ :code:`auto` |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |How to deal with conflicting allow/deny rules in a Permissions Document when checking if a DomainParticipant may exist. |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
authentication
""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|`com.rti.serv.secure.authentication.alternative_ca_files `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Mutability type |immutable |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Default Value |:code:`NULL` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Pattern value |:code:`.*(,.*)*` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Description |A comma-separated list of alternative Identity CA certificates. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|`com.rti.serv.secure.authentication.crl `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Mutability type |mutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Description |This Certificate Revocation List keeps track of untrusted X.509 certificates.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.authentication.enable_custom_algorithms `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Configures whether to enable custom cryptographic algorithms for the Authentication plugin. When enabled (not by default) the Security Plugins will enable additional digital signature and key establishment algorithms that are not part of the DDS Security specification (EDDSA+ED25519+SHA512, EDDSA+ED448+SHAKE256, ECDHE-CEUM+X25519, ECDHE-CEUM+X448). Currently only supported in combination with OpenSSL: this property will have no effect when used in combination with wolfSSL.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.authentication.enable_custom_allocators `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Configures whether to set custom crypto library (e.g., OpenSSL) allocators. When enabled (not the default) the Security Plugins will configure custom allocator functions (alloc, realloc, free) to the loaded crypto library with the goal of reducing memory fragmentation at the cost of a minimum performance impact. This is currently only supported in combination with OpenSSL. This property is only effective the first time a DomainParticipant loads the Security Plugins within the same process: subsequent DomainParticipant creations will ignore this property and leave the existing configuration unchanged. Moreover, this property is only effective if no allocation has been done with the crypto library builtin allocators before the Security Plugins have been loaded, otherwise a warning will be logged and no change will be made. Important: since the allocator functions live within the Security Plugins library, your application must not make any calls to the crypto library once the Security Plugins have been unloaded from memory.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.authentication.key_establishment_algorithm `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`AUTO` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`AUTO` |br|\ :code:`DHE+MODP-2048-256` |br|\ :code:`ECDHE-CEUM+P256` |br|\ :code:`ECDHE-CEUM+P384` |br|\ :code:`ECDHE-CEUM+X25519` |br|\ :code:`ECDHE-CEUM+X448` |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |The algorithm used to establish a shared secret during authentication. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.authentication.keyform `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`pem` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`engine` |br|\ :code:`pem` |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |The format of the private key specified by dds.sec.auth.private_key. If the value is engine, then the openssl_engine property must be set, and the private key must be successfully loaded by exactly one of the engines in that list.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|`com.rti.serv.secure.authentication.participant_discovery_protection_key `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Type |string |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Mutability type |immutable |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Description |Sets the static HMAC key used to compute participant discovery signatures.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.authentication.propagate_simplified_identity_certificate `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`true` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Indicates whether the identity certificate should be simplified |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.authentication.rsa_pss_pad `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`TRUE` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ :code:`AUTO` |br|\ :code:`auto` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Configures whether to use RSA PSS padding or standard RSA padding during authentication |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.authentication.shared_secret_algorithm `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`ecdh` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`dh` |br|\ :code:`ecdh` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |The algorithm used to establish a shared secret during authentication. This property is deprecated. Instead, use authentication.key_establishment_algorithm.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|The property has been deprecated in version |7.0.0 |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
cryptography
""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.cryptography.enable_additional_authenticated_data `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Enable Additional Authenticated Data for encode operations that support it. Currently only applicable to RTPS protection, where it is used to protect the RTPS Header and RTPS Header Extension Submessage if present. Must be set to true if using RTPS protection in combination with RTPS 2.5 Header Extension.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.cryptography.encryption_algorithm `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`AES256+GCM` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`AES128+GCM` |br|\ :code:`AES192+GCM` |br|\ :code:`AES256+GCM` |br|\ :code:`aes-128-gcm` |br|\ :code:`aes-192-gcm` |br|\ :code:`aes-256-gcm` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |The algorithm used for encrypting and decrypting data and metadata. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|`com.rti.serv.secure.cryptography.max_blocks_per_session `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Type |unsigned long long |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Mutability type |immutable |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Default Value |:code:`0xffffffffffffffff` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Min-Max value |:code:`[1,ULLONG_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Description |The number of message blocks that can be encrypted with the same key material.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.cryptography.max_receiver_specific_macs `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`0` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,3275]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Description |The maximum number of receiver-specific Message Authentication Codes (MACs) that are appended to an encoded result.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.cryptography.rtps_protection_key `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|Description |Sets the static HMAC key used to compute message signatures. This property is applied when hmac_only.enabled is false.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.cryptography.rtps_protection_preshared_key `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Description |PSK protection uses this password (in combination with publicly available data) to derive the key used for encoding RTPS messages|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.cryptography.rtps_protection_preshared_key_algorithm `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Default Value |:code:`AES256+GCM` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Possible values |:code:`AES128+GCM` |br|\ :code:`AES256+GCM` |br|\ :code:`AES128+GMAC` |br|\ :code:`AES256+GMAC` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Description |Algorithm used to protect messages when using pre-shared key protection |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.cryptography.share_key_for_metadata_and_data_protection `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`true` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|Description |Indicator of whether the metadata and data encoding operations share the same key material or use different keys.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
hmac_only
"""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.hmac_only.enabled `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Enables or disables the HMAC-only mode. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
hmac_only.cryptography
""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|`com.rti.serv.secure.hmac_only.cryptography.key `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Mutability type |immutable |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Default Value |:code:`NULL` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Pattern value |:code:`.*` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Description |Sets the static HMAC key used to compute message signatures.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.hmac_only.cryptography.max_blocks_per_session `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |unsigned integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`0xffffffffffffffff` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[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. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
logging
"""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|`com.rti.serv.secure.logging.log_level `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|Mutability type |immutable |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|Default Value |:code:`3` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|Min-Max value |:code:`[0,7]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|Description |The logging verbosity level. |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
|The property has been deprecated by |com.rti.serv.secure.logging.verbosity|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|`com.rti.serv.secure.logging.mode_mask `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Type |mask |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Mutability type |immutable |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Default Value |:code:`BUILTIN` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Possible values |:code:`BUILTIN` |br|\ :code:`SECURITY_TOPIC` |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Description |The mask to determine the logging mode(s). |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.logging.verbosity `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`ERROR` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`SILENT` |br|\ :code:`EMERGENCY` |br|\ :code:`ALERT` |br|\ :code:`CRITICAL` |br|\ :code:`ERROR` |br|\ :code:`WARNING` |br|\ :code:`NOTICE` |br|\ :code:`INFORMATIONAL` |br|\ :code:`DEBUG` |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |The logging verbosity level |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
logging.security_topic
""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.logging.security_topic.profile `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Description |QoS Library and QoS profile used to create logging-related entities (Publisher, Topic and DataWriter).|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
logging.security_topic.queue
""""""""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|`com.rti.serv.secure.logging.security_topic.queue.message_count_max `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Type |unsigned integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Mutability type |immutable |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Default Value |:code:`64` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Min-Max value |:code:`[0,UINT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Description |Maximum number of log messages in the logging queue.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|`com.rti.serv.secure.logging.security_topic.queue.message_size_max `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Type |unsigned integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Default Value |:code:`792` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Min-Max value |:code:`[27,UINT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Description |Maximum serialized size of a log message in the logging queue.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|`com.rti.serv.secure.logging.security_topic.queue.size `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Type |unsigned integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Default Value |:code:`50688` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Min-Max value |:code:`[0,UINT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Description |Size of the logging thread queue, in bytes.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
logging.security_topic.thread
"""""""""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.logging.security_topic.thread.message_threshold `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|Type |unsigned integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`256` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,UINT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|Description |Number of bytes to preallocate for the logging message string in the logging thread, beyond which dynamic allocation will occur.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|`com.rti.serv.secure.logging.security_topic.thread.plugin_method_threshold `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|Type |unsigned integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`80` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,UINT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|Description |Number of bytes to preallocate for the plugin method string in the logging thread, beyond which dynamic allocation will occur.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
dds.builtin_type
----------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.builtin_type.auto_register `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`true` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Register automatically the built-in types when a DomainParticipant is created. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Builtin Type |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
dds.clock
---------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|`dds.clock.external_clock `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Type |enum |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Default Value |:code:`realtime` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Possible values |:code:`realtime` |br|\ :code:`system` |br|\ :code:`monotonic` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Description |Comma-delimited list of clocks to use for the external clock, in the order of preference.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Related to these features |Clock |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|`dds.clock.internal_clock `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Type |enum |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Default Value |:code:`realtime` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Possible values |:code:`realtime` |br|\ :code:`system` |br|\ :code:`monotonic` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Description |Comma-delimited list of clocks to use for the internal clock, in the order of preference.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Related to these features |Clock |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
dds.discovery.endpoint
----------------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|`dds.discovery.endpoint.load_plugins `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Type |string |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Description |String indicating the prefix name of the plugin that will be loaded by Connext DDS.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
lbediscovery
^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|`dds.discovery.endpoint.lbediscovery.config_file `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Type |string |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Pattern value |:code:`.+\.xml` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Description |The name of the discovery configuration file.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Related to these features |Discovery |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|`dds.discovery.endpoint.lbediscovery.create_function `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Description |The name of the function that will be called by Connext DDS to create an instance of the LBED plugin.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|`dds.discovery.endpoint.lbediscovery.library `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Description |The name of the dynamic library that contains the LBED plugin implementation.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.discovery.endpoint.lbediscovery.property_validation_action `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`VALIDATION_ACTION_EXCEPTION` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`VALIDATION_ACTION_WARNING` |br|\ :code:`VALIDATION_ACTION_EXCEPTION` |br|\ :code:`VALIDATION_ACTION_SKIP` |br|\ :code:`-1` |br|\ :code:`0` |br|\ :code:`1` |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |configures the validation of the properties. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|`dds.discovery.endpoint.lbediscovery.verbosity `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Default Value |:code:`0` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Min-Max value |:code:`[-1,INT_MAX]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Description |The verbosity for the plugin, for debugging purposes.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Related to these features |Discovery |br|\ Logging |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
dds.discovery.participant
-------------------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|`dds.discovery.participant.load_plugins `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Description |String indicating the prefix name of the plugin that will be loaded by Connext DDS.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
lbpdiscovery
^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|`dds.discovery.participant.lbpdiscovery.config_file `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Pattern value |:code:`.+\.xml` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Description |The name of the discovery configuration file.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Related to these features |Discovery |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|`dds.discovery.participant.lbpdiscovery.create_function `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Description |The name of the function that will be called by Connext DDS to create an instance of the LBPD plugin.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|`dds.discovery.participant.lbpdiscovery.library `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Description |The name of the dynamic library that contains the LBPD plugin implementation. |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.discovery.participant.lbpdiscovery.property_validation_action `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`VALIDATION_ACTION_EXCEPTION` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`VALIDATION_ACTION_WARNING` |br|\ :code:`VALIDATION_ACTION_EXCEPTION` |br|\ :code:`VALIDATION_ACTION_SKIP` |br|\ :code:`-1` |br|\ :code:`0` |br|\ :code:`1` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |configures the validation of the properties. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|`dds.discovery.participant.lbpdiscovery.verbosity `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Default Value |:code:`0` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Min-Max value |:code:`[-1,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Description |The verbosity for the plugin, for debugging purposes.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
|Related to these features |Discovery |br|\ Logging |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+
dds.domain_participant
----------------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+
|`dds.domain_participant.asynchronous_publisher_thread_destruction_timeout `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+
|Default Value |:code:`10` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+
|Min-Max value |:code:`[0,60]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+
|Related to these features |Flow Controller |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
|`dds.domain_participant.domain_tag `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
|Pattern value |:code:`^.{0,255}$` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
|Description |A string defining the Domain Tag the DomainParticipant will propagate through Participant Discovery.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|`dds.domain_participant.filtering_character_encoding `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Type |enum |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Default Value |:code:`UTF-8` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Possible values |:code:`UTF-8` |br|\ :code:`ISO_8859` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Description |Select the character encoding for filtering|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
|Related to these features |Filtering |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|`dds.domain_participant.filtering_unicode_normalization `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NFC` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`OFF` |br|\ :code:`NFD` |br|\ :code:`NFC` |br|\ :code:`NFKD` |br|\ :code:`NFKC` |br|\ :code:`NFKC_Casefold` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Description |Select Unicode normalization for filter evaluation |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Filtering |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|`dds.domain_participant.max_announced_locator_list_size `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Default Value |:code:`16` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,16]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Description |A sequence of multicast settings used to configure the multicast addresses associated with a channel.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|`dds.domain_participant.network_interface_event_notification_delay `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`0` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,60000]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Description |Delays the DomainParticipant announcements that include a new interface for the number of milliseconds in the value of the property.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
auto_throttle
^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.domain_participant.auto_throttle.enable `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Configures the DomainParticipant to gather internal measurements (during DomainParticipant creation) that are required for the Auto Throttle feature.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Reliability |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
dds.flow_controller.token_bucket.
-------------------------------------------------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.flow_controller.token_bucket..scheduling_policy `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`DDS_EDF_FLOW_CONTROLLER_SCHED_POLICY` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`DDS_RR_FLOW_CONTROLLER_SCHED_POLICY` |br|\ :code:`DDS_EDF_FLOW_CONTROLLER_SCHED_POLICY` |br|\ :code:`DDS_HPF_FLOW_CONTROLLER_SCHED_POLICY` |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Specifies the scheduling policy to be used. |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Flow Controller |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
token_bucket
^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|`dds.flow_controller.token_bucket..token_bucket.bytes_per_token `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Default Value |:code:`-1` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Description |Maximum number of bytes allowed to send for each token available.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Related to these features |Flow Controller |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|`dds.flow_controller.token_bucket..token_bucket.max_tokens `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Default Value |:code:`-1` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Description |Maximum number of tokens than can accumulate in the token bucket.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
|Related to these features |Flow Controller |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|`dds.flow_controller.token_bucket..token_bucket.tokens_added_per_period `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Default Value |:code:`-1` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Min-Max value |:code:`[-1,INT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Description |Number of tokens added to the token bucket per specified period.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Related to these features |Flow Controller |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
|`dds.flow_controller.token_bucket..token_bucket.tokens_leaked_per_period `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
|Type |integer |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
|Default Value |:code:`0` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
|Description |Number of tokens removed from the token bucket per specified period.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
|Related to these features |Flow Controller |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
period
""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|`dds.flow_controller.token_bucket..token_bucket.period.nanosec `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|Type |unsigned integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|Default Value |:code:`0` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,UINT_MAX]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|Description |Period for adding tokens to and removing tokens from the bucket in nanoseconds.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|Related to these features |Flow Controller |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|`dds.flow_controller.token_bucket..token_bucket.period.sec `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Default Value |:code:`1` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Description |Period for adding tokens to and removing tokens from the bucket in seconds.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Related to these features |Flow Controller |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
dds.license
-----------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|`dds.license.license_file `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Mutability type |immutable |
+-----------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Pattern value |:code:`.*` |
+-----------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Description |Sets the path to the license file|
+-----------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Related to these features |License |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|`dds.license.license_string `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Pattern value |:code:`.*` |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Description |Sets the contents of the license.|
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
|Related to these features |License |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+
dds.participant
---------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.enable_backtrace_upon_sigsegv `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`auto` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`true` |br|\ :code:`FALSE` |br|\ :code:`false` |br|\ :code:`YES` |br|\ :code:`yes` |br|\ :code:`NO` |br|\ :code:`no` |br|\ :code:`AUTO` |br|\ :code:`auto` |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Enables backtrace printing when handling sigsegv signals. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Logging |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.property_validation_action `_| |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`VALIDATION_ACTION_EXCEPTION` |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`VALIDATION_ACTION_WARNING` |br|\ :code:`VALIDATION_ACTION_EXCEPTION` |br|\ :code:`VALIDATION_ACTION_SKIP` |br|\ :code:`-1` |br|\ :code:`0` |br|\ :code:`1` |br|\ |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |configures the validation of the properties. |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Other |br|\ |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.participant.use_45d_compatible_alignment_enforcement `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`true` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Accept RTPS messages with wrong alignment incorrectly. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Type System |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
builtin_data_writer.protocol
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.participant.builtin_data_writer.protocol.disable_repair_piggyback_heartbeat `_| |
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Prevents piggyback HBs from being sent with repair samples for builtin discovery topics |
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Reliability |br|\ |
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|The property has been promoted to | |
+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
discovery_config
^^^^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.participant.discovery_config.disable_endpoint_security_info_propagation `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataReader |br|\ DataWriter |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Participant may communicate for some combinations of inconsistent metadata/data protection kinds. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|The property has been deprecated in version |7.1.0 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.discovery_config.disable_participant_security_info_propagation `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Description |Participants may communicate for some combinations of inconsistent Governance's RTPS, discovery, and liveliness configurations.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|The property has been deprecated in version |7.1.0 |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.participant.discovery_config.force_endpoint_announcement_on_ip_mobility_event `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Forces the sending of endpoint discovery announcements when there is an IP mobility event. |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.discovery_config.use_stateless_participant_discovery_reader `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |If TRUE, makes Simple Participant Discovery robust against Sequence Number Attacks by switching the local Simple Participant Discovery DataReader's mode to pure stateless.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
inter_participant_data_reader.protocol
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.participant.inter_participant_data_reader.protocol.disable_preemptive_nack `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataReader |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Disable preemptive Heartbeats and NACKs. |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ Reliability |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
inter_participant_data_writer.protocol
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.participant.inter_participant_data_writer.protocol.disable_preemptive_heartbeat `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ DataWriter |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Disable preemptive Heartbeats and NACKs. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Discovery |br|\ Reliability |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
logging.time_based_logging.authentication
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|`dds.participant.logging.time_based_logging.authentication.timeout `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Default Value |:code:`INT_MAX` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Description |Print warning message when the authentication operation time exceeds this time threshold.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ Logging |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
logging.time_based_logging.event
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|`dds.participant.logging.time_based_logging.event.timeout `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Default Value |:code:`INT_MAX` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Description |Print warning message when the event start/execution time exceeds this time threshold.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
|Related to these features |Logging |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
logging.time_based_logging.process_received_message
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|`dds.participant.logging.time_based_logging.process_received_message.timeout `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Default Value |:code:`INT_MAX` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Description |Print warning message when processing a received message operation exceeds this time threshold.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Logging |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.logging.time_based_logging.process_received_message.tracked_ports `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Print warning message when the processing of a received message on a specific port exceeds the time threshold set in dds.participant.logging.time_based_logging.process_received_message.timeout.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Logging |br|\ Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
logging.time_based_logging.send
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|`dds.participant.logging.time_based_logging.send.timeout `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Default Value |:code:`INT_MAX` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Description |Print warning message when send operation time exceeds this time threshold.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Logging |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
protocol
^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.protocol.rtps_overhead `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DataWriter |br|\ DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`Automatically calculated.` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|Description |Used to adjust the overhead of the RTPS protocol without including security. This property is still supported, but deprecated in 6.1.2.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Reliability |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|The property has been deprecated in version |6.1.2 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
trust_plugins
^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.trust_plugins.key_revision_max_history_depth `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |unsigned integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`0` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,1000000]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Controls the number of key revisions that are used to encode samples in the DataWriters' queues. Must be 0 or between 7 and 1000000. If 0, then key revisions are disabled. A greater key_revision_max_history_depth will further delay the need to reencode writer queue historical samples as new key revisions are generated, but it will increase the memory footprint of the DomainParticipant. The memory used for this is preallocated, and it is roughly equal to 36 bytes (or 164 bytes if the DomainParticipant has at least one DataWriter using ODBC writer history) multiplied by the key_revision_max_history_depth. If there is at least one reliable DataWriter that is protecting its payload, then the DomainParticipant will send 7 key revisions instead of just 1 to each late joiner DomainParticipant. Each key revision adds about 128 bytes of network traffic, so that's 128 * (7 - 1) = 768 more bytes per late joiner DomainParticipant.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
authentication_request_delay
""""""""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|`dds.participant.trust_plugins.authentication_request_delay.sec `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Default Value |:code:`5` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Description |Controls the delay in seconds before sending an authentication_request to the remote participant.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
authentication_request_timeout
""""""""""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.trust_plugins.authentication_request_timeout.sec `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`20` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |It determines the timeout (in seconds) for authentication negotiations started from an authentication request message (authentication request is a DDS Security 1.1 mechanism to securely recover from an asymmetric liveliness loss). If set to a value greater than authentication_timeout, then it will be set to authentication_timeout.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
authentication_timeout
""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|`dds.participant.trust_plugins.authentication_timeout.sec `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Default Value |:code:`60` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Description |Controls the maximum time in seconds that an ongoing authentication can remain without completing.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
certificate_expiration_advance_notice_duration
""""""""""""""""""""""""""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.trust_plugins.certificate_expiration_advance_notice_duration.sec `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |unsigned integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |mutableUntilEnable |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`0` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Controls how much time in advance a DomainParticipantListener callback should notify the user when the local DomainParticipant's certificate is about to expire.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
max_key_redistribution_delay
""""""""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.participant.trust_plugins.max_key_redistribution_delay.sec `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Mutability type |immutable |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`60` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[-1,INT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Controls the maximum time in seconds between generating and using a new key (revision). After this time, remote DomainParticipants that have not yet acknowledged the new key (revision) will be completely removed. Must be -1 or between 1 and INT_MAX. If -1, then the local DomainParticipant will wait indefinitely for acknowledgments of the new key (revision).|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
dds.sec.access
--------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|`dds.sec.access.governance `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Pattern value |:code:`[file:\|data:,].*` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Description |The signed document that specifies the level of security required per domain and per topic.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|`dds.sec.access.permissions `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Pattern value |:code:`[file:\|data:,].*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Description |The signed document that specifies the access control permissions per domain and per topic.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.sec.access.permissions_ca `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`[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. |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
dds.sec.auth
------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|`dds.sec.auth.identity_ca `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Pattern value |:code:`[file:\|data:,].*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Description |This Identity Certificate Authority is used for signing authentication certificate files.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.sec.auth.identity_certificate `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Default Value |:code:`NULL` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Pattern value |:code:`[file:\|data:,].*` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |The private key associated with the first certificate.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|`dds.sec.auth.password `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Default Value |:code:`NULL` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Pattern value |:code:`.*` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Description |The password used to decrypt the private_key.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.sec.auth.private_key `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Default Value |:code:`NULL` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Pattern value |:code:`[file:\|data:,].*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |The private key associated with the first certificate.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |DDS Secure |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
dds.sys_info
------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.sys_info.creation_timestamp `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Min-Max value |:code:`[0,9999]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |Time when the executable was created. |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |System Info |br|\ Default Discovery Propagation |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.sys_info.executable_filepath `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Pattern value |:code:`.*` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |Name and full path of the executable. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |System Info |br|\ Default Discovery Propagation |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.sys_info.execution_timestamp `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Min-Max value |:code:`[0,9999]` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |Time when the execution started. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |System Info |br|\ Default Discovery Propagation |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.sys_info.hostname `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |Hostname |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |System Info |br|\ Default Discovery Propagation |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.sys_info.process_id `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |unsigned integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Min-Max value |:code:`[0,UINT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |Process ID |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |System Info |br|\ Default Discovery Propagation |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.sys_info.target `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Pattern value |:code:`.*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |Architecture for which the library was compiled. |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |System Info |br|\ Default Discovery Propagation |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.sys_info.username `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |Username that is running the process. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |System Info |br|\ Default Discovery Propagation |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
dds.transport
-------------
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|`dds.transport.load_plugins `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Description |Comma-separated strings indicating the prefix names of all plugins that will be loaded by Connext DDS.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|`dds.transport.minimum_compatibility_version `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Default Value |:code:`6.0.0` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Pattern value |:code:`.*` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Description |Minimum version that the transport should be compatible with.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.use_510_compatible_locator_kinds `_| |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Communicate between Connext DDS 5.2.0 and previous releases. This property is still supported, but deprecated in favour of dds.transport.minimum_compatibility_version.|
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|The property has been deprecated in version |6.1.0 |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
TCPv4.tcp1
^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.aliases `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*[,.*]*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Used to register the transport plugin returned by NDDS_Transport_TCPv4_create() (as specified by .create_function) to the DomainParticipant.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.bind_interface_address `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Description |The TCP transport can be configured to bind all sockets to a specified interface.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.client_connection_negotiation_timeout `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Default Value |:code:`10` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Min-Max value |:code:`[1,INT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Description |Timeout (in seconds) for negotiating a client data connection.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
|`dds.transport.TCPv4.tcp1.create_function `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
|Description |If used, must be "NDDS_Transport_TCPv4_create".|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.create_function_ptr `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Description |Defines the function pointer to the TCP transport plugin creation function.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.disable_interface_tracking `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Disables detection of network interface changes. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.disable_nagle `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Disables the TCP nagle algorithm. |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.enable_keep_alive `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Configures the sending of KEEP_ALIVE messages in TCP. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.force_asynchronous_send `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Forces asynchronous send. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.force_crc_check `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |When set to 1, forces the checking of the CRC for received RTI TCP messages. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.force_interface_poll_detection `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Description |Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.ignore_loopback_interface `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`true` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Prevents the transport plugin from using the IP loopback interface. |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.ignore_nonrunning_interfaces `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`true` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Description |Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.initial_handshake_timeout `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Default Value |:code:`10` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Min-Max value |:code:`[1,INT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Description |Timeout (in seconds) for the initial handshake for a connection.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.interface_poll_period `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Type |unsigned integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Default Value |:code:`500` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Description |Specifies the period in milliseconds to query for changes in the state of all the interfaces.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.keep_alive_interval `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Default Value |:code:`-1` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Description |Specifies the interval in seconds between KEEP_ALIVE retries.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.keep_alive_retry_count `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Default Value |:code:`-1` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Description |The maximum number of KEEP_ALIVE retries before dropping the connection.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.keep_alive_time `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Default Value |:code:`-1` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Description |Specifies the interval of inactivity in seconds that causes TCP to generate a KEEP_ALIVE message.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+
|`dds.transport.TCPv4.tcp1.library `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+
|Pattern value |:code:`.*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+
|Description |If used, must be 'nddstransporttcp'.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.logging_verbosity_bitmap `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|Type |mask |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|Default Value |:code:`-1` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|Description |Bitmap that specifies the verbosity of log messages from the transport.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|Related to these features |Transport |br|\ Logging |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+
|`dds.transport.TCPv4.tcp1.max_packet_size `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+
|Default Value |:code:`-1` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+
|Description |The maximum size of a TCP segment.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.negotiate_session_id `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |When set to 1, the TCP transport plugin will perform a session negotiation that will help external load balancers identify all the connections associated with a particular session between two Connext DDS applications.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.outstanding_connection_cookies `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
|Default Value |:code:`100` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
|Description |Maximum number of outstanding connection cookies allowed by the transport when acting as a server .|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.outstanding_connection_cookies_life_span `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Default Value |:code:`-1` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Min-Max value |:code:`[INT_MIN,INT_MAX]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Description |Maximum lifespan (in seconds) of the cookies associated with pending connections.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.property_validation_action `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`VALIDATION_ACTION_EXCEPTION` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`VALIDATION_ACTION_WARNING` |br|\ :code:`VALIDATION_ACTION_EXCEPTION` |br|\ :code:`VALIDATION_ACTION_SKIP` |br|\ :code:`-1` |br|\ :code:`0` |br|\ :code:`1` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |configures the validation of the properties. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.public_address `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,255]` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Description |Public IP address and port (WAN address and port) (separated with ':') associated with the transport instantiation.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.recv_socket_buffer_size `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
|Default Value |:code:`131072` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
|Description |Size, in bytes, of the receive buffer of a socket used for receiving.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.security_logging_verbosity_bitmap `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Type |mask |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Default Value |:code:`-1` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Description |Bitmap that specifies the verbosity of security related log messages from the transport. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ Logging |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.send_crc `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |When set to 1, enables the computation of the CRC for sent RTI TCP messages. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.send_max_wait_sec `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`3` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[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.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.send_socket_buffer_size `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Default Value |:code:`131072` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Description |Size, in bytes, of the send buffer of a socket used for sending.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.server_bind_port `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Default Value |:code:`7400` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Description |Private IP port (inside the LAN) used by the transport to accept TCP connections.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.server_connection_negotiation_timeout `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Default Value |:code:`10` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Min-Max value |:code:`[1,INT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Description |Timeout (in seconds) for negotiating a server data connection.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.server_socket_backlog `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|Default Value |:code:`5` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|Description |The backlog parameter determines what is the maximum length of the queue of pending connections.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.shared_write_buffer_allocation `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Description | Indicates if the allocation settings in write_buffer_allocation are global to the transport or per destination.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.socket_monitoring_kind `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Type |enum |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Default Value |:code:`SELECT` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Possible values |:code:`SELECT` |br|\ :code:`WINDOWS_IOCP` |br|\ :code:`WINDOWS_WAITFORMULTIPLEOBJECTS` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Description |Configures the socket monitoring API used by the transport. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls_create_function_ptr `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Type |pointer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Description |Defines the function pointer to the TLS Support creation function.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls_delete_function_ptr `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Type |pointer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Description |Defines the function pointer to the TLS Support deletion function.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|`dds.transport.TCPv4.tcp1.transport_priority_mapping_high `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Default Value |:code:`0xFF` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Description |Sets the high value of the output range to IPv4 TOS.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|`dds.transport.TCPv4.tcp1.transport_priority_mapping_low `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Default Value |:code:`0` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Description |Sets the low value of the output range to IPv4 TOS.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+
|`dds.transport.TCPv4.tcp1.transport_priority_mask `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+
|Default Value |:code:`0` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+
|Description |Mask for the transport priority field.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.user_timeout `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Default Value |:code:`0` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Description |Changes the default OS TCP User Timeout configuration.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
connection_liveliness
"""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|`dds.transport.TCPv4.tcp1.connection_liveliness.assertions_per_lease_duration `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Default Value |:code:`3` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Description |Configures the connection liveliness feature.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.connection_liveliness.enable `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Configures the connection liveliness feature. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|`dds.transport.TCPv4.tcp1.connection_liveliness.lease_duration `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Default Value |:code:`10` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Description |Configures the connection liveliness feature.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
control_attribute_allocation
""""""""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.control_attribute_allocation.incremental_count `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Default Value |:code:`-1` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Description |Allocation settings applied to control message attributes.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.control_attribute_allocation.initial_count `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Default Value |:code:`2` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Description |Allocation settings applied to control message attributes.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.control_attribute_allocation.max_count `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Type |integer |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Default Value |:code:`-1` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Description |Allocation settings applied to control message attributes.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+
control_buffer_allocation
"""""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.control_buffer_allocation.incremental_count `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Default Value |:code:`-1` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Description |Allocation settings applied to buffers used to serialize and send control messages.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.control_buffer_allocation.initial_count `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Default Value |:code:`2` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Description |Allocation settings applied to buffers used to serialize and send control messages.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.control_buffer_allocation.max_count `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Default Value |:code:`-1` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Description |Allocation settings applied to buffers used to serialize and send control messages.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
control_message_allocation
""""""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|`dds.transport.TCPv4.tcp1.control_message_allocation.incremental_count `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Type |integer |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Default Value |:code:`-1` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Min-Max value |:code:`[-MIN_INT,MAX_INT]` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Description |Allocation settings applied to control messages.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|`dds.transport.TCPv4.tcp1.control_message_allocation.initial_count `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Default Value |:code:`2` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Description |Allocation settings applied to control messages.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|`dds.transport.TCPv4.tcp1.control_message_allocation.max_count `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Default Value |:code:`-1` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Description |Allocation settings applied to control messages.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
event_thread
""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.event_thread.mask `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Type |mask |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`PRIORITY_ENFORCE \| STDIO` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`STDIO` |br|\ :code:`FLOATING_POINT` |br|\ :code:`REALTIME_PRIORITY` |br|\ :code:`PRIORITY_ENFORCE` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Description |Configures the event thread used by the TCP Transport plugin for providing some features. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.event_thread.priority `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`THREAD_PRIORITY_NORMAL` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`THREAD_PRIORITY_DEFAULT` |br|\ :code:`THREAD_PRIORITY_HIGH` |br|\ :code:`THREAD_PRIORITY_ABOVE_NORMAL` |br|\ :code:`THREAD_PRIORITY_NORMAL` |br|\ :code:`THREAD_PRIORITY_BELOW_NORMAL` |br|\ :code:`THREAD_PRIORITY_LOW` |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Configures the event thread used by the TCP Transport plugin for providing some features. |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.event_thread.stack_size `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Default Value |:code:`THREAD_STACK_SIZE_DEFAULT` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Pattern value |:code:`THREAD_STACK_SIZE_DEFAULT` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Min-Max value |:code:`[INT_MIN,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Description |Configures the event thread used by the TCP Transport plugin for providing some features.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
parent
""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.parent.allow_interfaces_list `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*(,.*)*` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Description |A list of strings, each identifying a range of interface addresses or an interface name that can be used by the transport.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.parent.classid `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Type |integer |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NDDS_TRANSPORT_CLASSID_TCPV4_LAN` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[INT_MIN,INT_MAX]` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`NDDS_TRANSPORT_CLASSID_INVALID` |br|\ :code:`NDDS_TRANSPORT_CLASSID_ANY` |br|\ :code:`NDDS_TRANSPORT_CLASSID_TCPV4_WAN` |br|\ :code:`NDDS_TRANSPORT_CLASSID_TCPV4_LAN` |br|\ :code:`NDDS_TRANSPORT_CLASSID_TLSV4_LAN` |br|\ :code:`NDDS_TRANSPORT_CLASSID_TLSV4_WAN` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Description |Must be set to one of the listed possible values. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.parent.deny_interfaces_list `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*(,.*)*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Description |A list of strings, each identifying a range of interface addresses or an interface name that will not be used by the transport.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.parent.gather_send_buffer_count_max `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`128` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|Description |Specifies the maximum number of buffers that Connext DDS can pass to the send() method of a transport plugin.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.parent.max_interface_count `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Type |integer |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Default Value |:code:`-1` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Min-Max value |:code:`[-1,INT_MAX]` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Description |Maximum number of valid interfaces that will be used from the allow_interfaces_list|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.parent.message_size_max `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
|Default Value |:code:`65536` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
|Description |The maximum size of a message in bytes that can be sent or received by the transport plugin.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+
|`dds.transport.TCPv4.tcp1.parent.thread_name_prefix `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+
|Default Value |:code:`rTr#####` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+
|Pattern value |:code:`^.{0,8}$` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+
|Description |Prefix used to name the transport threads.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+
read_buffer_allocation
""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|`dds.transport.TCPv4.tcp1.read_buffer_allocation.incremental_count `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Type |integer |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Default Value |:code:`-1` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Description |Allocation settings applied to read buffers.|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Related to these features |Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|`dds.transport.TCPv4.tcp1.read_buffer_allocation.initial_count `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Default Value |:code:`2` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Description |Allocation settings applied to read buffers.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|`dds.transport.TCPv4.tcp1.read_buffer_allocation.max_count `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Type |integer |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Default Value |:code:`-1` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Min-Max value |:code:`[MIN_INT,MAX_INT]` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Description |Allocation settings applied to read buffers.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Related to these features |Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
tls.cipher
""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.cipher.cipher_list `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Type |enum |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`RTITLS_CIPHER_LIST_DEFAULT` |br|\ :code:`RTITLS_CIPHER_LIST_ENCRYPT_HIGH` |br|\ :code:`RTITLS_CIPHER_LIST_UNENCRYPTED` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Description |List of available TLS ciphers when communicating with 6.0.0 or below. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.cipher.ciphersuites `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Description |List of available TLS ciphersuites when communicating with 6.0.1 or above.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.cipher.dh_param_files `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Default Value |:code:`NULL` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Possible values |:code:`0-9` |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Description |List of available Diffie-Hellman (DH) key files.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.cipher.engine_id `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+
|Type |string |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+
|Default Value |:code:`NULL` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+
|Pattern value |:code:`.*` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+
|Description |ID of OpenSSL cipher engine to request.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+
tls.identity
""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.identity.certificate_chain `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|Description |String containing an identifying certificate (in PEM format) or certificate chain (appending intermediate CA certs in order).|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.identity.certificate_chain_file `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Description |File containing identifying certificate (in PEM format) or certificate chain (appending intermediate CA certs in order).|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.identity.private_key `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
|Type |string |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
|Default Value |:code:`NULL` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
|Pattern value |:code:`.*` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
|Description |String containing private key (in PEM format).|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.identity.private_key_file `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Type |string |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Default Value |:code:`NULL` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Pattern value |:code:`.*` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Description |File containing private key (in PEM format).|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.identity.private_key_password `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|Default Value |:code:`NULL` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|Description |A string that specifies the password for the private key.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.identity.rsa_private_key `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Type |string |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Default Value |:code:`NULL` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Pattern value |:code:`.*` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Description |String containing additional RSA private key (in PEM format).|
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.identity.rsa_private_key_file `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|Default Value |:code:`NULL` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|Pattern value |:code:`.*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|Description |File containing additional RSA private key (in PEM format).|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
tls.verify
""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.verify.ca_file `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Type |string |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Description |A string that specifies the name of a file containing Certificate Authority certificates.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.verify.ca_path `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Type |string |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Default Value |:code:`NULL` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Pattern value |:code:`.*` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Description |A string that specifies paths to directories containing Certificate Authority certificates.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.verify.crl_file `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Type |string |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Default Value |:code:`NULL` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Pattern value |:code:`.*` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Description |Name of the file containing the Certificate Revocation List.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+
|`dds.transport.TCPv4.tcp1.tls.verify.verify_depth `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+
|Default Value |:code:`-1` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+
|Min-Max value |:code:`[INT_MIN,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+
|Description |Maximum certificate chain length for verification.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+
|Related to these features |Transport |br|\ Transport Secure |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+
windows_iocp
""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|`dds.transport.TCPv4.tcp1.windows_iocp.concurrency_value `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Type |unsigned integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Default Value |:code:`1` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Description |Configures I/O completion ports.|
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Related to these features |Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|`dds.transport.TCPv4.tcp1.windows_iocp.thread_pool_size `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Type |unsigned integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Default Value |:code:`2` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Description |Configures I/O completion ports.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
write_buffer_allocation
"""""""""""""""""""""""
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.write_buffer_allocation.incremental_count `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Type |integer |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Default Value |:code:`10` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Description |Allocation settings applied to buffers used for asynchronous (non-blocking) write.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.write_buffer_allocation.initial_count `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Type |integer |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Default Value |:code:`4` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Description |Allocation settings applied to buffers used for asynchronous (non-blocking) write.|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|`dds.transport.TCPv4.tcp1.write_buffer_allocation.max_count `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Type |integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Default Value |:code:`1000` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,INT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Description |Allocation settings applied to buffers used for asynchronous (non-blocking) write.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
UDPv4.builtin
^^^^^^^^^^^^^
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.aliases `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Type |string |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Pattern value |:code:`.*[,.*]*` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Description |Aliases used to register the transport to the DomainParticipant.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
|Related to these features |Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.disable_interface_tracking `_| |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Disables detection of network interface changes. |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|The property has been promoted to | |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.force_interface_poll_detection `_| |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Description |Forces the interface tracker to use a polling method to detect changes to the network interfaces in IP mobility scenarios.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|The property has been promoted to | |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.ignore_loopback_interface `_| |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Type |integer |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Default Value |:code:`-1` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Possible values |:code:`-1` |br|\ :code:`0` |br|\ :code:`1` |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Description |Prevents the transport plugin from using the IP loopback interface. |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
|The property has been promoted to ||
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.ignore_nonrunning_interfaces `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Type |boolean |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`true` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Description |Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|The property has been promoted to | |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.ignore_nonup_interfaces `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`true` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |This property is only supported on Windows platforms with statically configured IP addresses. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.interface_poll_period `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Type |unsigned integer |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Default Value |:code:`500` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,UINT_MAX]` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Description |Specifies the period in milliseconds to query for changes in the state of all the interfaces.|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
|The property has been promoted to | |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.join_multicast_group_timeout `_| |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Type |unsigned integer |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Default Value |:code:`5000` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Min-Max value |:code:`[0,UINT_MAX]` |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Description |Controls how long Connext DDS will retry to join a multicast group with a new network interface before withdrawing.|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|The property has been promoted to | |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.multicast_enabled `_| |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`true` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Allows the transport plugin to use multicast for sending and receiving. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|The property has been promoted to | |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}|L|
.. table::
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|`dds.transport.UDPv4.builtin.multicast_loopback_disabled `_| |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|May be set in |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Applies to |DomainParticipant |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Type |boolean |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Default Value |:code:`false` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Possible values |:code:`0` |br|\ :code:`1` |br|\ :code:`TRUE` |br|\ :code:`FALSE` |br|\ :code:`YES` |br|\ :code:`NO` |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Description |Prevents the transport plugin from putting multicast packets onto the loopback interface. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|Related to these features |Transport |br|\ Builtin Transport |br|\ |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|The property has been promoted to |