Skip to content

Commit c66212f

Browse files
committed
Refs #23169: Add docs
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
1 parent 9ba97f9 commit c66212f

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
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 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, 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|

0 commit comments

Comments
 (0)