Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[17206] Restore participant domainID tag in XML profile #464

Merged
merged 3 commits into from
Feb 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion code/XMLTester.xml
Original file line number Diff line number Diff line change
Expand Up @@ -828,6 +828,7 @@
<profiles xmlns="http://www.eprosima.com/XMLSchemas/fastRTPS_Profiles">
-->
<participant profile_name="domainparticipant_profile_name">
<domainId>4</domainId>
<rtps>
<name>DomainParticipant Name</name>

Expand Down Expand Up @@ -3465,4 +3466,4 @@
</types>


</dds>
</dds>
1 change: 1 addition & 0 deletions code/XMLTesterExample.xml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
</transport_descriptors>

<participant profile_name="participant_profile_example">
<domainId>4</domainId>
<rtps>
<name>Participant Name</name> <!-- String -->

Expand Down
24 changes: 21 additions & 3 deletions docs/fastdds/xml_configuration/domainparticipant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,26 @@ The ``<participant>`` element has two attributes defined: ``profile_name`` and `
DomainParticipant configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``<participant>`` element has as child element ``<rtps>`` under which all the DomainParticipant configuration
options belong.
The ``<participant>`` element has two child elements: ``<domainId>`` and ``<rtps>``.
All the DomainParticipant configuration options belong to the ``<rtps>`` element, except for the DDS |DomainId-api|
which is defined by the ``<domainId>`` element.
Below a list with the configuration XML elements is presented:

+----------------+----------------------------------------------------------------------------+--------------+---------+
| Name | Description | Values | Default |
+================+============================================================================+==============+=========+
| ``<domainId>`` | DomainId to be used by the DomainParticipant. | ``uint32_t`` | 0 |
| | See :ref:`dds_layer_domainParticipant_creation_profile`. | | |
+----------------+----------------------------------------------------------------------------+--------------+---------+
| ``<rtps>`` | *Fast DDS* DomainParticipant configurations. |br| | :ref:`RTPS` | |
| | See :ref:`RTPS`. | | |
+----------------+----------------------------------------------------------------------------+--------------+---------+

.. _RTPS:

RTPS element type
"""""""""""""""""

The following is a list with all the possible child XML elements of the ``<rtps>`` element.
These elements allow the user to define the DomainParticipant configuration.

Expand Down Expand Up @@ -166,7 +184,7 @@ These elements allow the user to define the DomainParticipant configuration.
:language: xml
:start-after: <!-->XML-PARTICIPANT<-->
:end-before: <!--><-->
:lines: 2-3, 5-87, 89
:lines: 2-3, 5-88, 90

.. note::

Expand Down