Complete flow_controller_descriptor references in xml sections (#824)

* Refs #21231: Add missing <flow_controller_descriptor_list> to domainparticipant xml Signed-off-by: Mario Dominguez <[email protected]> * Refs #21231: Add missing <flow_controller_name> to datawriter xml qos Signed-off-by: Mario Dominguez <[email protected]> * Refs #21131: Apply Jesus rev Signed-off-by: Mario Dominguez <[email protected]> * Refs #21131: Apply Edu suggestion Signed-off-by: Mario Dominguez <[email protected]> --------- Signed-off-by: Mario Dominguez <[email protected]> (cherry picked from commit 6e7f076) # Conflicts: # code/XMLTester.xml # code/XMLTesterExample.xml # docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst # docs/fastdds/xml_configuration/common.rst # docs/fastdds/xml_configuration/domainparticipant.rst
eProsima · Jun 27, 2024 · 1856d5f · 1856d5f
1 parent 6eed613
commit 1856d5f
Show file tree

Hide file tree

Showing 5 changed files with 379 additions and 1 deletion.
diff --git a/code/XMLTester.xml b/code/XMLTester.xml
@@ -1594,11 +1594,78 @@
                 <!-- ALLOCATION -->
             </allocation>
 
+<<<<<<< HEAD
             <userData>
                 <value>13.40.37.00.CE</value>
             </userData>
         </rtps>
     </participant>
+=======
+                <userData>
+                    <value>3.4.7.0.C</value>
+                </userData>
+
+                <prefix>72.61.73.70.66.61.72.6d.74.65.73.74</prefix>
+
+                <builtin_controllers_sender_thread>
+                    <scheduling_policy>-1</scheduling_policy>
+                    <priority>0</priority>
+                    <affinity>0</affinity>
+                    <stack_size>-1</stack_size>
+                </builtin_controllers_sender_thread>
+
+                <timed_events_thread>
+                    <scheduling_policy>-1</scheduling_policy>
+                    <priority>0</priority>
+                    <affinity>0</affinity>
+                    <stack_size>-1</stack_size>
+                </timed_events_thread>
+
+                <discovery_server_thread>
+                    <scheduling_policy>-1</scheduling_policy>
+                    <priority>0</priority>
+                    <affinity>0</affinity>
+                    <stack_size>-1</stack_size>
+                </discovery_server_thread>
+
+                <typelookup_service_thread>
+                    <scheduling_policy>-1</scheduling_policy>
+                    <priority>0</priority>
+                    <affinity>0</affinity>
+                    <stack_size>-1</stack_size>
+                </typelookup_service_thread>
+
+                <builtin_transports_reception_threads>
+                    <scheduling_policy>-1</scheduling_policy>
+                    <priority>0</priority>
+                    <affinity>0</affinity>
+                    <stack_size>-1</stack_size>
+                </builtin_transports_reception_threads>
+
+                <security_log_thread>
+                    <scheduling_policy>-1</scheduling_policy>
+                    <priority>0</priority>
+                    <affinity>0</affinity>
+                    <stack_size>-1</stack_size>
+                </security_log_thread>
+
+                <flow_controller_descriptor_list>
+                    <flow_controller_descriptor>
+                        <name>example_flow_controller</name>
+                        <scheduler>FIFO</scheduler>
+                        <max_bytes_per_period>4096</max_bytes_per_period>
+                        <period_ms>500</period_ms>
+                        <sender_thread>
+                            <scheduling_policy>-1</scheduling_policy>
+                            <priority>0</priority>
+                            <affinity>0</affinity>
+                            <stack_size>-1</stack_size>
+                        </sender_thread>
+                    </flow_controller_descriptor>
+                </flow_controller_descriptor_list>
+            </rtps>
+        </participant>
+>>>>>>> 6e7f076 (Complete flow_controller_descriptor references in xml sections (#824))
 <!--
 </profiles>
 -->

diff --git a/code/XMLTesterExample.xml b/code/XMLTesterExample.xml
@@ -261,6 +261,7 @@
 
                 <useBuiltinTransports>false</useBuiltinTransports>
 
+<<<<<<< HEAD
                 <builtinTransports>DEFAULT</builtinTransports>
 
                 <propertiesPolicy>
@@ -277,6 +278,29 @@
                         </property>
                     </properties>
                 </propertiesPolicy>
+=======
+                <security_log_thread>
+                    <scheduling_policy>-1</scheduling_policy>
+                    <priority>0</priority>
+                    <affinity>0</affinity>
+                    <stack_size>-1</stack_size>
+                </security_log_thread>
+
+                <flow_controller_descriptor_list>
+                    <flow_controller_descriptor>
+                        <name>example_flow_controller</name>
+                        <scheduler>FIFO</scheduler>
+                        <max_bytes_per_period>4096</max_bytes_per_period>
+                        <period_ms>500</period_ms>
+                        <sender_thread>
+                            <scheduling_policy>-1</scheduling_policy>
+                            <priority>0</priority>
+                            <affinity>0</affinity>
+                            <stack_size>-1</stack_size>
+                        </sender_thread>
+                    </flow_controller_descriptor>
+                </flow_controller_descriptor_list>
+>>>>>>> 6e7f076 (Complete flow_controller_descriptor references in xml sections (#824))
             </rtps>
         </participant>
 
@@ -333,6 +357,7 @@
                 </partition>
                 <publishMode>
                     <kind>ASYNCHRONOUS</kind>
+                    <flow_controller_name>example_flow_controller</flow_controller_name>
                 </publishMode>
                 <disablePositiveAcks>
                     <enabled>true</enabled>

diff --git a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst
@@ -213,6 +213,7 @@ This QoS configures the list of flow controllers of a participant, so they can l
 its DataWriters.
 It is a vector of shared pointers to |FlowControllerDescriptor-api|, which has the following fields:
 
+<<<<<<< HEAD
 +------------------------------------------------------+-------------------------------------+-------------------------+
 | Data Member Name                                     | Type                                | Default Value           |
 +======================================================+=====================================+=========================+
@@ -224,6 +225,30 @@ It is a vector of shared pointers to |FlowControllerDescriptor-api|, which has t
 +------------------------------------------------------+-------------------------------------+-------------------------+
 | |FlowControllerDescriptor::period_ms-api|            | ``uint64_t``                        | 100                     |
 +------------------------------------------------------+-------------------------------------+-------------------------+
+=======
+.. list-table::
+   :header-rows: 1
+   :align: left
+
+   * - Data Member Name
+     - Type
+     - Default Value
+   * - |FlowControllerDescriptor::name-api|
+     - ``string``
+     -
+   * - |FlowControllerDescriptor::scheduler-api|
+     - |FlowControllerSchedulerPolicy-api|
+     - FIFO_SCHED_POLICY-api|
+   * - |FlowControllerDescriptor::max_bytes_per_period-api|
+     - ``int32_t``
+     - 0 (i.e. infinite)
+   * - |FlowControllerDescriptor::period_ms-api|
+     - ``uint64_t``
+     - 100
+   * - |FlowControllerDescriptor::sender_thread-api|
+     - |ThreadSettings|
+     -
+>>>>>>> 6e7f076 (Complete flow_controller_descriptor references in xml sections (#824))
 
 Please refer to :ref:`flow-controllers` section for more information.
 
@@ -493,7 +518,7 @@ List of QoS Policy data members:
      - :ref:`publishmodeqospolicykind`
      - |SYNCHRONOUS_PUBLISH_MODE-api|
    * - |PublishModeQosPolicy::flow_ctrl_name-api|
-     - ``const char *``
+     - ``string``
      - |FASTDDS_FLOW_CONTROLLER_DEFAULT-api|
 
 .. note::

diff --git a/docs/fastdds/xml_configuration/common.rst b/docs/fastdds/xml_configuration/common.rst
@@ -300,6 +300,76 @@ Liveliness
 | ``<announcement_period>`` | See :ref:`livelinessqospolicy`. |                                 | |c_TimeInfinite-api| |
 +---------------------------+---------------------------------+---------------------------------+----------------------+
 
+<<<<<<< HEAD
+=======
+.. _xml_ownership:
+
+Ownership
+"""""""""
+
+.. list-table::
+  :header-rows: 1
+  :align: left
+
+  * - Name
+    - Description
+    - Values
+    - Default
+  * - ``<kind>``
+    - See :ref:`ownershipqospolicykind`.
+    - |SHARED-xml-api| |br|
+      |EXCLUSIVE-xml-api|
+    - |SHARED-xml-api|
+
+.. _xml_ownershipstrength:
+
+Ownership Strength
+""""""""""""""""""
+
++------------------+----------------------------------------+--------------------------------------+-------------------+
+| Name             | Description                            | Values                               | Default           |
++==================+========================================+======================================+===================+
+| ``<value>``      | See                                    | ``uint32_t``                         | 0                 |
+|                  | :ref:`ownershipstrengthqospolicy`.     |                                      |                   |
++------------------+----------------------------------------+--------------------------------------+-------------------+
+
+.. important::
+
+    This configuration is only available for :ref:`DataWriter QoS profile configuration <publisherprofiles>`.
+
+.. _xml_partition:
+
+Partition
+"""""""""
+
++---------------------------+-----------------------------------------------------------------------------+------------+
+| Name                      | Description                                                                 | Values     |
++===========================+=============================================================================+============+
+| ``<names>``               | It comprises a set of ``<name>`` elements containing the name of each       | ``<name>`` |
+|                           | partition. |br| See :ref:`partitionqospolicy`.                              |            |
+|                           |                                                                             |            |
++---------------------------+-----------------------------------------------------------------------------+------------+
+
+.. _xml_publishmode:
+
+PublishMode
+"""""""""""
+
++--------------------------+---------------------------------------+------------------+------------------+
+| Name                     | Description                           | Values           | Default          |
++==========================+=======================================+==================+==================+
+| ``<kind>``               | See :ref:`publishmodeqospolicy`.      | ``ASYNCHRONOUS`` | ``ASYNCHRONOUS`` |
+|                          |                                       +------------------+                  |
+|                          |                                       | ``SYNCHRONOUS``  |                  |
++--------------------------+---------------------------------------+------------------+------------------+
+|``<flow_controller_name>``| :ref:`flowcontrollersqos` name.       | ``<string>``     | Empty            |
++--------------------------+---------------------------------------+------------------+------------------+
+
+.. important::
+
+    This configuration is only available for :ref:`DataWriter QoS profile configuration <publisherprofiles>`.
+
+>>>>>>> 6e7f076 (Complete flow_controller_descriptor references in xml sections (#824))
 .. _xml_reliability:
 
 ReliabilityQosPolicy
@@ -482,3 +552,35 @@ and to :ref:`realtime-allocations` for detailed information on how to tune alloc
      - Number of new elements that will be allocated when more space is |br| necessary.
      - ``uint32_t``
      - 1
+
+.. _flowcontrollers_xml:
+
+Flow Controller Descriptors
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This ``<flow_controller_descriptor_list>`` element configures the list of flow controllers of a participant,
+so they can later be used on its DataWriters.
+Please refer to :ref:`flowcontrollersqos` for a detailed documentation.
+
+.. list-table::
+   :header-rows: 1
+   :align: left
+
+   * - Data Member Name
+     - Type
+     - Default Value
+   * - ``<name>``
+     - ``string``
+     - Empty
+   * - ``<scheduler>``
+     - |FlowControllerSchedulerPolicy-api|
+     - |FIFO_SCHED_POLICY-api|
+   * - ``<max_bytes_per_period>``
+     - ``int32_t``
+     - 0 (i.e. infinite)
+   * - ``<period_ms>``
+     - ``uint64_t``
+     - 100
+   * - ``<sender_thread>``
+     - :ref:`ThreadSettingsType`
+     -