Skip to content

Commit 913de2f

Browse files
Mario-DLMario-DL
authored
Documentation for the optional serialization of WireProtocolConfigQos (#1068)
* Refs #23169: Add docs Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #23169: Doc monitor service proxy optional qos Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> * Refs #23169: Apply Carlo's review Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com> --------- Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
1 parent 52ce7fa commit 913de2f

File tree

4 files changed

+48
-38
lines changed

4 files changed

+48
-38
lines changed

‎code/DDSCodeTester.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -988,7 +988,7 @@ void dds_domain_examples()
988988

989989
pqos.properties().properties().emplace_back(
990990
"fastdds.serialize_optional_qos",
991-
"True");
991+
"true"); // true or True or TRUE or 1
992992
//!--
993993
}
994994
}

‎code/XMLTester.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3305,7 +3305,7 @@
33053305
<properties>
33063306
<property>
33073307
<name>fastdds.serialize_optional_qos</name>
3308-
<value>True</value>
3308+
<value>true</value> <!-- true, True, TRUE, 1 -->
33093309
</property>
33103310
</properties>
33113311
</propertiesPolicy>

‎docs/fastdds/property_policies/non_consolidated_qos.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -480,31 +480,35 @@ The different property values have the following effects on the local |DomainPar
480480
Adding optional QoS to Discovery data
481481
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
482482

483-
During the Endpoint Discovery Phase (EDP), |DataWriters-api| and |DataReaders-api| acknowledge each other.
483+
During :ref:`discovery`, |DomainParticipants-api|, |DataWriters-api| and |DataReaders-api| acknowledge each other.
484+
This is performed in two phases, the Participant Discovery Phase (PDP) and the Endpoint Discovery Phase (EDP).
484485
To do that, the DomainParticipants share information about their DataWriters and DataReaders with each other,
485-
using the communication channels established during the PDP.
486+
using the communication channels established during the PDP phase.
486487
This information contains all data required to match the endpoints, such as the |Topic-api|, data type, and
487488
certain :ref:`QoS Policies <dds_layer_core_policy>` that might affect matching.
488489
Specific compatibility rules can be found in each QoS section of :ref:`QoS Policies <dds_layer_core_policy>`.
489490

490-
However, there are some QoS that are not mandatory for matching, but can be useful to have in the EDP messages.
491-
Property ``fastdds.serialize_optional_qos`` allows the user to include these optional QoS in the EDP messages.
491+
However, there are some QoS that are not mandatory for matching, but can be useful to have upon discovery.
492+
Property ``fastdds.serialize_optional_qos`` allows the user to include these optional QoS during discovery.
492493
This property is configured at the |DomainParticipant-api| level through the policy :ref:`propertypolicyqos`.
493-
Hence, all associated endpoints to that |DomainParticipant-api| will send their optional QoS in the EDP messages.
494+
Hence, the |DomainParticipant-api| and all its associated endpoints will send their optional QoS
495+
in the discovery messages.
494496

495497
Optional QoS, like any other QoS, will only be serialized if they have non-default values.
496498
Not receiving information about a QoS in the EDP message means that it has a default value.
497499
Optional QoS will be serialized if the value of the property is set to ``TRUE``, ``True``, ``true`` or ``1``, any
498500
other value will be considered as not set or ``FALSE``.
499501

500-
The following table lists all the optional QoS that can be serialized in the EDP messages:
502+
The following table lists all the optional QoS that can be serialized in the discovery messages:
501503

502504
.. list-table::
503505
:header-rows: 1
504506
:align: left
505507

506508
* - PropertyPolicyQos
507509
- Applies to:
510+
* - |WireProtocolConfigQos-api|
511+
- |DomainParticipant-api|.
508512
* - |ResourceLimitsQosPolicy-api|
509513
- |DataWriter-api| and |DataReaders-api|.
510514
* - |TransportPriorityQosPolicy-api|

‎docs/fastdds/statistics/monitor_service/monitor_service_topics.rst

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -28,36 +28,42 @@ The possible values are described in the following table:
2828

2929
.. _monitoring_statuses:
3030

31-
+---------+-----------------------------+----------------------------------------------------+
32-
|**Value**| **Name** | **Description** |
33-
+---------+-----------------------------+----------------------------------------------------+
34-
| 0 | ``ProxyInfo`` | Collection of Parameters describing the |
35-
| | | ``Proxy Data`` of that entity |
36-
+---------+-----------------------------+----------------------------------------------------+
37-
| 1 | ``ConnectionList`` | List of connections that this entity is |
38-
| | | using with its matched remote entities. |
39-
+---------+-----------------------------+----------------------------------------------------+
40-
| 2 | ``IncompatibleQoSInfo`` | Status of the Incompatible QoS |
41-
| | | of that entity. |
42-
+---------+-----------------------------+----------------------------------------------------+
43-
| 3 | ``InconsistentTopicInfo`` | Status of Inconsistent topics that the |
44-
| | | topic of that entity has. |
45-
+---------+-----------------------------+----------------------------------------------------+
46-
| 4 | ``LivelinessLostInfo`` | Tracks the status of the number of times |
47-
| | | a writer lost liveliness. |
48-
+---------+-----------------------------+----------------------------------------------------+
49-
| 5 | ``LivelinessChangedInfo`` | Tracks the status of the number of times |
50-
| | | the liveliness changed in a reader. |
51-
+---------+-----------------------------+----------------------------------------------------+
52-
| 6 | ``DeadlineMissedInfo`` | The Status of the number of deadlines |
53-
| | | missed of a sample for that entity. |
54-
+---------+-----------------------------+----------------------------------------------------+
55-
| 7 | ``SampleLostInfo`` | Tracks the status of the number of times |
56-
| | | this entity lost samples. |
57-
+---------+-----------------------------+----------------------------------------------------+
58-
| 8 | ``ExtendedIncompatibleQoS`` | Stores the list of remote incompatible ``GUIDs`` |
59-
| | | and QoS policies for each local entity guid. |
60-
+---------+-----------------------------+----------------------------------------------------+
31+
+---------+-----------------------------+------------------------------------------------------+
32+
|**Value**| **Name** | **Description** |
33+
+---------+-----------------------------+------------------------------------------------------+
34+
| 0 | ``ProxyInfo`` | Collection of Parameters describing the |
35+
| | | ``Proxy Data`` of that entity. Contains optional qos.|
36+
+---------+-----------------------------+------------------------------------------------------+
37+
| 1 | ``ConnectionList`` | List of connections that this entity is |
38+
| | | using with its matched remote entities. |
39+
+---------+-----------------------------+------------------------------------------------------+
40+
| 2 | ``IncompatibleQoSInfo`` | Status of the Incompatible QoS |
41+
| | | of that entity. |
42+
+---------+-----------------------------+------------------------------------------------------+
43+
| 3 | ``InconsistentTopicInfo`` | Status of Inconsistent topics that the |
44+
| | | topic of that entity has. |
45+
+---------+-----------------------------+------------------------------------------------------+
46+
| 4 | ``LivelinessLostInfo`` | Tracks the status of the number of times |
47+
| | | a writer lost liveliness. |
48+
+---------+-----------------------------+------------------------------------------------------+
49+
| 5 | ``LivelinessChangedInfo`` | Tracks the status of the number of times |
50+
| | | the liveliness changed in a reader. |
51+
+---------+-----------------------------+------------------------------------------------------+
52+
| 6 | ``DeadlineMissedInfo`` | The Status of the number of deadlines |
53+
| | | missed of a sample for that entity. |
54+
+---------+-----------------------------+------------------------------------------------------+
55+
| 7 | ``SampleLostInfo`` | Tracks the status of the number of times |
56+
| | | this entity lost samples. |
57+
+---------+-----------------------------+------------------------------------------------------+
58+
| 8 | ``ExtendedIncompatibleQoS`` | Stores the list of remote incompatible ``GUIDs`` |
59+
| | | and QoS policies for each local entity guid. |
60+
+---------+-----------------------------+------------------------------------------------------+
61+
62+
.. note::
63+
64+
The ``ProxyInfo`` within the ``Monitor Service Status Topic``
65+
always includes the :ref:`optional qos <property_serialize_optional_qos>` independently of the
66+
``fastdds.serialize_optional_qos`` property.
6167

6268
.. note::
6369

0 commit comments

Comments
 (0)