Skip to content

Commit fbd01d3

Browse files
mergify[bot]Mario-DL
mergify[bot]
and
Mario-DL
authored
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 <mariodominguez@eprosima.com> Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com>
1 parent c24b83f commit fbd01d3

File tree

5 files changed

+83
-20
lines changed

5 files changed

+83
-20
lines changed

‎code/XMLTester.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1049,6 +1049,15 @@
10491049
</userData>
10501050

10511051
<prefix>72.61.73.70.66.61.72.6d.74.65.73.74</prefix>
1052+
1053+
<flow_controller_descriptor_list>
1054+
<flow_controller_descriptor>
1055+
<name>example_flow_controller</name>
1056+
<scheduler>FIFO</scheduler>
1057+
<max_bytes_per_period>4096</max_bytes_per_period>
1058+
<period_ms>500</period_ms>
1059+
</flow_controller_descriptor>
1060+
</flow_controller_descriptor_list>
10521061
</rtps>
10531062
</participant>
10541063
<!--

‎code/XMLTesterExample.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,15 @@
372372
<dynamic>true</dynamic>
373373
</send_buffers>
374374
</allocation>
375+
376+
<flow_controller_descriptor_list>
377+
<flow_controller_descriptor>
378+
<name>example_flow_controller</name>
379+
<scheduler>FIFO</scheduler>
380+
<max_bytes_per_period>4096</max_bytes_per_period>
381+
<period_ms>500</period_ms>
382+
</flow_controller_descriptor>
383+
</flow_controller_descriptor_list>
375384
</rtps>
376385
</participant>
377386

@@ -450,6 +459,7 @@
450459
</partition>
451460
<publishMode>
452461
<kind>ASYNCHRONOUS</kind>
462+
<flow_controller_name>example_flow_controller</flow_controller_name>
453463
</publishMode>
454464
<reliability>
455465
<kind>BEST_EFFORT</kind>

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

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -213,17 +213,25 @@ This QoS configures the list of flow controllers of a participant, so they can l
213213
its DataWriters.
214214
It is a vector of shared pointers to |FlowControllerDescriptor-api|, which has the following fields:
215215

216-
+------------------------------------------------------+-------------------------------------+-------------------------+
217-
| Data Member Name | Type | Default Value |
218-
+======================================================+=====================================+=========================+
219-
| |FlowControllerDescriptor::name-api| | ``const char *`` | |
220-
+------------------------------------------------------+-------------------------------------+-------------------------+
221-
| |FlowControllerDescriptor::scheduler-api| | |FlowControllerSchedulerPolicy-api| | |FIFO_SCHED_POLICY-api| |
222-
+------------------------------------------------------+-------------------------------------+-------------------------+
223-
| |FlowControllerDescriptor::max_bytes_per_period-api| | ``int32_t`` | 0 (i.e. infinite) |
224-
+------------------------------------------------------+-------------------------------------+-------------------------+
225-
| |FlowControllerDescriptor::period_ms-api| | ``uint64_t`` | 100 |
226-
+------------------------------------------------------+-------------------------------------+-------------------------+
216+
.. list-table::
217+
:header-rows: 1
218+
:align: left
219+
220+
* - Data Member Name
221+
- Type
222+
- Default Value
223+
* - |FlowControllerDescriptor::name-api|
224+
- ``string``
225+
-
226+
* - |FlowControllerDescriptor::scheduler-api|
227+
- |FlowControllerSchedulerPolicy-api|
228+
- |FIFO_SCHED_POLICY-api|
229+
* - |FlowControllerDescriptor::max_bytes_per_period-api|
230+
- ``int32_t``
231+
- 0 (i.e. infinite)
232+
* - |FlowControllerDescriptor::period_ms-api|
233+
- ``uint64_t``
234+
- 100
227235

228236
Please refer to :ref:`flow-controllers` section for more information.
229237

@@ -496,7 +504,7 @@ List of QoS Policy data members:
496504
- :ref:`publishmodeqospolicykind`
497505
- |SYNCHRONOUS_PUBLISH_MODE-api|
498506
* - |PublishModeQosPolicy::flow_ctrl_name-api|
499-
- ``const char *``
507+
- ``string``
500508
- |FASTDDS_FLOW_CONTROLLER_DEFAULT-api|
501509

502510
.. note::

‎docs/fastdds/xml_configuration/common.rst

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -602,13 +602,15 @@ Partition
602602
PublishMode
603603
"""""""""""
604604

605-
+-----------------------+---------------------------------------+------------------+------------------+
606-
| Name | Description | Values | Default |
607-
+=======================+=======================================+==================+==================+
608-
| ``<kind>`` | See :ref:`publishmodeqospolicy`. | ``ASYNCHRONOUS`` | ``ASYNCHRONOUS`` |
609-
| | +------------------+ |
610-
| | | ``SYNCHRONOUS`` | |
611-
+-----------------------+---------------------------------------+------------------+------------------+
605+
+--------------------------+---------------------------------------+------------------+------------------+
606+
| Name | Description | Values | Default |
607+
+==========================+=======================================+==================+==================+
608+
| ``<kind>`` | See :ref:`publishmodeqospolicy`. | ``ASYNCHRONOUS`` | ``ASYNCHRONOUS`` |
609+
| | +------------------+ |
610+
| | | ``SYNCHRONOUS`` | |
611+
+--------------------------+---------------------------------------+------------------+------------------+
612+
|``<flow_controller_name>``| :ref:`flowcontrollersqos` name. | ``<string>`` | Empty |
613+
+--------------------------+---------------------------------------+------------------+------------------+
612614

613615
.. important::
614616

@@ -730,3 +732,32 @@ and to :ref:`realtime-allocations` for detailed information on how to tune alloc
730732
- Number of new elements that will be allocated when more space is |br| necessary.
731733
- ``uint32_t``
732734
- 1
735+
736+
.. _flowcontrollers_xml:
737+
738+
Flow Controller Descriptors
739+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
740+
741+
This ``<flow_controller_descriptor_list>`` element configures the list of flow controllers of a participant,
742+
so they can later be used on its DataWriters.
743+
Please refer to :ref:`flowcontrollersqos` for a detailed documentation.
744+
745+
.. list-table::
746+
:header-rows: 1
747+
:align: left
748+
749+
* - Data Member Name
750+
- Type
751+
- Default Value
752+
* - ``<name>``
753+
- ``string``
754+
- Empty
755+
* - ``<scheduler>``
756+
- |FlowControllerSchedulerPolicy-api|
757+
- |FIFO_SCHED_POLICY-api|
758+
* - ``<max_bytes_per_period>``
759+
- ``int32_t``
760+
- 0 (i.e. infinite)
761+
* - ``<period_ms>``
762+
- ``uint64_t``
763+
- 100

‎docs/fastdds/xml_configuration/domainparticipant.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,14 +183,19 @@ These elements allow the user to define the DomainParticipant configuration.
183183
delivery is used. See :ref:`intraprocess-delivery`.
184184
- ``string``
185185
- Empty
186+
* - ``<flow_controller_descriptor_list>``
187+
- Defined flow controller descriptors to be used by the |br|
188+
DomainParticipant. See :ref:`flowcontrollers_xml`.
189+
- |FlowControllersQos|
190+
-
186191

187192
**Example**
188193

189194
.. literalinclude:: /../code/XMLTester.xml
190195
:language: xml
191196
:start-after: <!-->XML-PARTICIPANT<-->
192197
:end-before: <!--><-->
193-
:lines: 2-3, 5-88, 90
198+
:lines: 2-3, 5-97, 99
194199

195200
.. note::
196201

0 commit comments

Comments
 (0)