Complete flow_controller_descriptor references in xml sections (#824) (…

…#829) * Refs #21231: Add missing <flow_controller_descriptor_list> to domainparticipant xml * Refs #21231: Add missing <flow_controller_name> to datawriter xml qos * Refs #21131: Apply Jesus rev * Refs #21131: Apply Edu suggestion --------- Signed-off-by: Mario Dominguez <[email protected]> Co-authored-by: Mario Domínguez López <[email protected]>
eProsima · Sep 12, 2024 · fbd01d3 · fbd01d3
1 parent c24b83f
commit fbd01d3
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 20 deletions.
diff --git a/code/XMLTester.xml b/code/XMLTester.xml
@@ -1049,6 +1049,15 @@
             </userData>
 
             <prefix>72.61.73.70.66.61.72.6d.74.65.73.74</prefix>
+
+            <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>
+                </flow_controller_descriptor>
+            </flow_controller_descriptor_list>
         </rtps>
     </participant>
 <!--

diff --git a/code/XMLTesterExample.xml b/code/XMLTesterExample.xml
@@ -372,6 +372,15 @@
                         <dynamic>true</dynamic>
                     </send_buffers>
                 </allocation>
+
+                <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>
+                    </flow_controller_descriptor>
+                </flow_controller_descriptor_list>
             </rtps>
         </participant>
 
@@ -450,6 +459,7 @@
                 </partition>
                 <publishMode>
                     <kind>ASYNCHRONOUS</kind>
+                    <flow_controller_name>example_flow_controller</flow_controller_name>
                 </publishMode>
                 <reliability>
                     <kind>BEST_EFFORT</kind>

diff --git a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst
@@ -213,17 +213,25 @@ 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:
 
-+------------------------------------------------------+-------------------------------------+-------------------------+
-| Data Member Name                                     | Type                                | Default Value           |
-+======================================================+=====================================+=========================+
-| |FlowControllerDescriptor::name-api|                 | ``const char *``                    |                         |
-+------------------------------------------------------+-------------------------------------+-------------------------+
-| |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                     |
-+------------------------------------------------------+-------------------------------------+-------------------------+
+.. 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
 
 Please refer to :ref:`flow-controllers` section for more information.
 
@@ -496,7 +504,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
@@ -602,13 +602,15 @@ Partition
 PublishMode
 """""""""""
 
-+-----------------------+---------------------------------------+------------------+------------------+
-| Name                  | Description                           | Values           | Default          |
-+=======================+=======================================+==================+==================+
-| ``<kind>``            | See :ref:`publishmodeqospolicy`.      | ``ASYNCHRONOUS`` | ``ASYNCHRONOUS`` |
-|                       |                                       +------------------+                  |
-|                       |                                       | ``SYNCHRONOUS``  |                  |
-+-----------------------+---------------------------------------+------------------+------------------+
++--------------------------+---------------------------------------+------------------+------------------+
+| Name                     | Description                           | Values           | Default          |
++==========================+=======================================+==================+==================+
+| ``<kind>``               | See :ref:`publishmodeqospolicy`.      | ``ASYNCHRONOUS`` | ``ASYNCHRONOUS`` |
+|                          |                                       +------------------+                  |
+|                          |                                       | ``SYNCHRONOUS``  |                  |
++--------------------------+---------------------------------------+------------------+------------------+
+|``<flow_controller_name>``| :ref:`flowcontrollersqos` name.       | ``<string>``     | Empty            |
++--------------------------+---------------------------------------+------------------+------------------+
 
 .. important::
 
@@ -730,3 +732,32 @@ 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
diff --git a/docs/fastdds/xml_configuration/domainparticipant.rst b/docs/fastdds/xml_configuration/domainparticipant.rst
@@ -183,14 +183,19 @@ These elements allow the user to define the DomainParticipant configuration.
        delivery is used. See :ref:`intraprocess-delivery`.
      - ``string``
      - Empty
+   * - ``<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-3, 5-88, 90
+    :lines: 2-3, 5-97, 99
 
 .. note::