Refs #21231: Add missing <flow_controller_descriptor_list> to domainp…

…articipant xml Signed-off-by: Mario Dominguez <[email protected]>
eProsima · Jun 25, 2024 · da838e8 · da838e8
1 parent 0c5175c
commit da838e8
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 2 deletions.
diff --git a/code/XMLTester.xml b/code/XMLTester.xml
@@ -1511,6 +1511,21 @@
                     <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>
 <!--

diff --git a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst
@@ -422,7 +422,7 @@ It is a vector of shared pointers to |FlowControllerDescriptor-api|, which has t
      - Type
      - Default Value
    * - |FlowControllerDescriptor::name-api|
-     - ``const char *``
+     - ``string``
      -
    * - |FlowControllerDescriptor::scheduler-api|
      - |FlowControllerSchedulerPolicy-api|

diff --git a/docs/fastdds/xml_configuration/common.rst b/docs/fastdds/xml_configuration/common.rst
@@ -846,3 +846,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``
+     -
+   * - ``<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`
+     -
diff --git a/docs/fastdds/xml_configuration/domainparticipant.rst b/docs/fastdds/xml_configuration/domainparticipant.rst
@@ -215,14 +215,19 @@ These elements allow the user to define the DomainParticipant configuration.
      - |ThreadSettings| for the security log thread.
      - |ThreadSettings|
      -
+   * - ``<flow_controller_descriptor_list>``
+     - Defined flow controller descriptors to be used by the |br|
+       DomainParticipant. See :ref:`flowcontrollers_xml`.
+     - |FlowControllersQos|
+     -
 
 **Example**
 
 .. literalinclude:: /../code/XMLTester.xml
     :language: xml
     :start-after: <!-->XML-PARTICIPANT<-->
     :end-before: <!--><-->
-    :lines: 2-4, 6-128, 130-131
+    :lines: 2-4, 6-150, 152-153
 
 .. note::