Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions docs/rst/notes/forthcoming_version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,16 @@
###################
Forthcoming Version
###################

This release includes the following **new features**:

* *Fast DDS Spy* now supports topic-name endpoint profile lookup:
when creating a :term:`DataReader` for a topic, a loaded XML profile whose name
matches the topic name is automatically applied, giving users full control over QoS fields such as
history, memory policy and transport.
For more details, see :ref:`user_manual_configuration_xml_endpoint_profiles`.

This release includes the following **documentation updates**:

* Document topic-name endpoint profile lookup for the *Fast DDS Spy*,
including QoS fields always enforced by the *Fast DDS Spy* regardless of the profile.
32 changes: 32 additions & 0 deletions docs/rst/user_manual/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,38 @@ The XML content must follow the same format as an XML file and will be loaded as
dds-profile: "participant_profile"


.. _user_manual_configuration_xml_endpoint_profiles:

Endpoint profiles
^^^^^^^^^^^^^^^^^

Profiles named after a topic are automatically applied to :term:`DataReader` endpoints
when they are created for that topic.
When the |spy| creates a :term:`DataReader` for a topic, it looks for a loaded XML profile
whose name matches the topic name.
If a matching profile is found, the endpoint is configured using that profile's QoS, giving the user full
control over fields such as history, memory policy, transport, etc.
If no matching profile exists, the endpoint falls back to default QoS with values derived from the YAML configuration.

.. note::

Certain QoS are always enforced by the *Fast DDS Spy* regardless of the XML profile:
``expects_inline_qos`` on DataReaders for keyed topics.

The following example loads a profile named ``my_topic`` that will be automatically applied when creating
endpoints for a topic of that name:

.. code-block:: xml

<dds>
<profiles>
<data_reader profile_name="my_topic">
<historyMemoryPolicy>DYNAMIC</historyMemoryPolicy>
</data_reader>
</profiles>
</dds>


.. _user_manual_configuration_dds__topic_filtering:

Topic Filtering
Expand Down