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

Jump to bottom

[16328] Explain necesity to do get_qos before set_qos in DomainParticipant #430

Merged
merged 3 commits into from
Dec 13, 2022
Merged

[16328] Explain necesity to do get_qos before set_qos in DomainParticipant #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4793759
Refs #16328: Explain necesity to do get_qos before set_qos in DomainP…
MRicoIE2CS Dec 9, 2022
9c8b064
Refs #16328: Update explanation
MRicoIE2CS Dec 12, 2022
27d27a2
Update docs/fastdds/dds_layer/domain/domainParticipant/domainParticip…
MRicoIE2CS Dec 12, 2022
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
2 changes: 1 addition & 1 deletion docs/03-exports/aliases-api.include
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
.. |DomainParticipant::set_default_publisher_qos-api| replace:: :cpp:func:`set_default_publisher_qos()<eprosima::fastdds::dds::DomainParticipant::set_default_publisher_qos>`
.. |DomainParticipant::set_default_subscriber_qos-api| replace:: :cpp:func:`set_default_subscriber_qos()<eprosima::fastdds::dds::DomainParticipant::set_default_subscriber_qos>`
.. |DomainParticipant::set_default_topic_qos-api| replace:: :cpp:func:`set_default_topic_qos()<eprosima::fastdds::dds::DomainParticipant::set_default_topic_qos>`
.. |DomainParticipant::get_qos-api| replace:: :cpp:func:`get_qos()<eprosima::fastdds::dds::DomainParticipant::get_qos>`
.. |DomainParticipant::get_qos-api| replace:: :cpp:func:`DomainParticipant::get_qos()<eprosima::fastdds::dds::DomainParticipant::get_qos>`
.. |DomainParticipant::get_publisher_qos_from_profile| replace:: :cpp:func:`get_publisher_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_publisher_qos_from_profile>`
.. |DomainParticipant::get_subscriber_qos_from_profile| replace:: :cpp:func:`get_subscriber_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_subscriber_qos_from_profile>`
.. |DomainParticipant::get_topic_qos_from_profile| replace:: :cpp:func:`get_topic_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_topic_qos_from_profile>`
Expand Down
13 changes: 13 additions & 0 deletions docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,19 @@ Internally it contains the following |QosPolicy-api| objects:
|BuiltinAttributes::discovery_config-api| within |WireProtocolConfigQos::builtin-api| (see
:ref:`DS_modify_server_list`).


.. important::

Upon the call to |DomainParticipantFactory::create_participant-api|, if Fast DDS is compiled with statistics support
(enabled by default, see :ref:`cmake_options`), the internal |DomainParticipantQos-api| may differ from the input
|DomainParticipantQos-api| (see :ref:`property_policies_statistics`).
This entails that applications willing to further modify the |DomainParticipantQos-api| after
|DomainParticipant-api| creation should:

1. Retrieve the internal |DomainParticipantQos-api| by the means of |DomainParticipant::get_qos-api|.
2. Perform the desired modifications.
3. Update the |DomainParticipantQos-api| by the means of |DomainParticipant::set_qos-api|.

Refer to the detailed description of each QosPolicy class for more information about their usage and
default values.

Expand Down