Skip to content

Commit 6e7f076

Browse files
Mario-DLMario-DL
authored
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 <mariodominguez@eprosima.com> * Refs #21231: Add missing <flow_controller_name> to datawriter xml qos Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21131: Apply Jesus rev Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #21131: Apply Edu suggestion Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
1 parent 718152d commit 6e7f076

5 files changed

Lines changed: 80 additions & 10 deletions

File tree

‎code/XMLTester.xml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1511,6 +1511,21 @@
15111511
<affinity>0</affinity>
15121512
<stack_size>-1</stack_size>
15131513
</security_log_thread>
1514+
1515+
<flow_controller_descriptor_list>
1516+
<flow_controller_descriptor>
1517+
<name>example_flow_controller</name>
1518+
<scheduler>FIFO</scheduler>
1519+
<max_bytes_per_period>4096</max_bytes_per_period>
1520+
<period_ms>500</period_ms>
1521+
<sender_thread>
1522+
<scheduling_policy>-1</scheduling_policy>
1523+
<priority>0</priority>
1524+
<affinity>0</affinity>
1525+
<stack_size>-1</stack_size>
1526+
</sender_thread>
1527+
</flow_controller_descriptor>
1528+
</flow_controller_descriptor_list>
15141529
</rtps>
15151530
</participant>
15161531
<!--

‎code/XMLTesterExample.xml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,21 @@
498498
<affinity>0</affinity>
499499
<stack_size>-1</stack_size>
500500
</security_log_thread>
501+
502+
<flow_controller_descriptor_list>
503+
<flow_controller_descriptor>
504+
<name>example_flow_controller</name>
505+
<scheduler>FIFO</scheduler>
506+
<max_bytes_per_period>4096</max_bytes_per_period>
507+
<period_ms>500</period_ms>
508+
<sender_thread>
509+
<scheduling_policy>-1</scheduling_policy>
510+
<priority>0</priority>
511+
<affinity>0</affinity>
512+
<stack_size>-1</stack_size>
513+
</sender_thread>
514+
</flow_controller_descriptor>
515+
</flow_controller_descriptor_list>
501516
</rtps>
502517
</participant>
503518

@@ -576,6 +591,7 @@
576591
</partition>
577592
<publishMode>
578593
<kind>ASYNCHRONOUS</kind>
594+
<flow_controller_name>example_flow_controller</flow_controller_name>
579595
</publishMode>
580596
<reliability>
581597
<kind>BEST_EFFORT</kind>

‎docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ It is a vector of shared pointers to |FlowControllerDescriptor-api|, which has t
422422
- Type
423423
- Default Value
424424
* - |FlowControllerDescriptor::name-api|
425-
- ``const char *``
425+
- ``string``
426426
-
427427
* - |FlowControllerDescriptor::scheduler-api|
428428
- |FlowControllerSchedulerPolicy-api|
@@ -736,7 +736,7 @@ List of QoS Policy data members:
736736
- :ref:`publishmodeqospolicykind`
737737
- |SYNCHRONOUS_PUBLISH_MODE-api|
738738
* - |PublishModeQosPolicy::flow_ctrl_name-api|
739-
- ``const char *``
739+
- ``string``
740740
- |FASTDDS_FLOW_CONTROLLER_DEFAULT-api|
741741

742742
.. note::

‎docs/fastdds/xml_configuration/common.rst‎

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -718,13 +718,15 @@ Partition
718718
PublishMode
719719
"""""""""""
720720

721-
+-----------------------+---------------------------------------+------------------+------------------+
722-
| Name | Description | Values | Default |
723-
+=======================+=======================================+==================+==================+
724-
| ``<kind>`` | See :ref:`publishmodeqospolicy`. | ``ASYNCHRONOUS`` | ``ASYNCHRONOUS`` |
725-
| | +------------------+ |
726-
| | | ``SYNCHRONOUS`` | |
727-
+-----------------------+---------------------------------------+------------------+------------------+
721+
+--------------------------+---------------------------------------+------------------+------------------+
722+
| Name | Description | Values | Default |
723+
+==========================+=======================================+==================+==================+
724+
| ``<kind>`` | See :ref:`publishmodeqospolicy`. | ``ASYNCHRONOUS`` | ``ASYNCHRONOUS`` |
725+
| | +------------------+ |
726+
| | | ``SYNCHRONOUS`` | |
727+
+--------------------------+---------------------------------------+------------------+------------------+
728+
|``<flow_controller_name>``| :ref:`flowcontrollersqos` name. | ``<string>`` | Empty |
729+
+--------------------------+---------------------------------------+------------------+------------------+
728730

729731
.. important::
730732

@@ -846,3 +848,35 @@ and to :ref:`realtime-allocations` for detailed information on how to tune alloc
846848
- Number of new elements that will be allocated when more space is |br| necessary.
847849
- ``uint32_t``
848850
- 1
851+
852+
.. _flowcontrollers_xml:
853+
854+
Flow Controller Descriptors
855+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
856+
857+
This ``<flow_controller_descriptor_list>`` element configures the list of flow controllers of a participant,
858+
so they can later be used on its DataWriters.
859+
Please refer to :ref:`flowcontrollersqos` for a detailed documentation.
860+
861+
.. list-table::
862+
:header-rows: 1
863+
:align: left
864+
865+
* - Data Member Name
866+
- Type
867+
- Default Value
868+
* - ``<name>``
869+
- ``string``
870+
- Empty
871+
* - ``<scheduler>``
872+
- |FlowControllerSchedulerPolicy-api|
873+
- |FIFO_SCHED_POLICY-api|
874+
* - ``<max_bytes_per_period>``
875+
- ``int32_t``
876+
- 0 (i.e. infinite)
877+
* - ``<period_ms>``
878+
- ``uint64_t``
879+
- 100
880+
* - ``<sender_thread>``
881+
- :ref:`ThreadSettingsType`
882+
-

‎docs/fastdds/xml_configuration/domainparticipant.rst‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,14 +215,19 @@ These elements allow the user to define the DomainParticipant configuration.
215215
- |ThreadSettings| for the security log thread.
216216
- |ThreadSettings|
217217
-
218+
* - ``<flow_controller_descriptor_list>``
219+
- Defined flow controller descriptors to be used by the |br|
220+
DomainParticipant. See :ref:`flowcontrollers_xml`.
221+
- |FlowControllersQos|
222+
-
218223

219224
**Example**
220225

221226
.. literalinclude:: /../code/XMLTester.xml
222227
:language: xml
223228
:start-after: <!-->XML-PARTICIPANT<-->
224229
:end-before: <!--><-->
225-
:lines: 2-4, 6-128, 130-131
230+
:lines: 2-4, 6-150, 152-153
226231

227232
.. note::
228233

0 commit comments

Comments
 (0)