Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[21231] Complete flow_controller_descriptor references in xml sections #824

Merged
merged 4 commits into from
Jun 26, 2024
Merged

[21231] Complete flow_controller_descriptor references in xml sections #824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da838e8
Refs #21231: Add missing <flow_controller_descriptor_list> to domainp…
Mario-DL Jun 25, 2024
2178f2e
Refs #21231: Add missing <flow_controller_name> to datawriter xml qos
Mario-DL Jun 25, 2024
24b290b
Refs #21131: Apply Jesus rev
Mario-DL Jun 25, 2024
ccbc726
Refs #21131: Apply Edu suggestion
Mario-DL Jun 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions code/XMLTester.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
<!--
Expand Down
16 changes: 16 additions & 0 deletions code/XMLTesterExample.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,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>

Expand Down Expand Up @@ -576,6 +591,7 @@
</partition>
<publishMode>
<kind>ASYNCHRONOUS</kind>
<flow_controller_name>example_flow_controller</flow_controller_name>
</publishMode>
<reliability>
<kind>BEST_EFFORT</kind>
Expand Down
4 changes: 2 additions & 2 deletions docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
JesusPoderoso marked this conversation as resolved.
Show resolved Hide resolved
-
* - |FlowControllerDescriptor::scheduler-api|
- |FlowControllerSchedulerPolicy-api|
Expand Down Expand Up @@ -736,7 +736,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::
Expand Down
48 changes: 41 additions & 7 deletions docs/fastdds/xml_configuration/common.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,13 +718,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::

Expand Down Expand Up @@ -846,3 +848,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`
-
7 changes: 6 additions & 1 deletion docs/fastdds/xml_configuration/domainparticipant.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down