Skip to content

Commit 58bf4fd

Browse files
committed
Documented changes for Topic Profile Lookup
Signed-off-by: Zakaria Talbi Lalmi <zakariatalbi@eprosima.com>
1 parent 545fdbf commit 58bf4fd

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

docs/rst/notes/forthcoming_version.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,16 @@
66
###################
77
Forthcoming Version
88
###################
9+
10+
This release includes the following **new features**:
11+
12+
* *Fast DDS Spy* now supports topic-name endpoint profile lookup:
13+
when creating a :term:`DataReader` for a topic, a loaded XML profile whose name
14+
matches the topic name is automatically applied, giving users full control over QoS fields such as
15+
history, memory policy and transport.
16+
For more details, see :ref:`user_manual_configuration_xml_endpoint_profiles`.
17+
18+
This release includes the following **documentation updates**:
19+
20+
* Document topic-name endpoint profile lookup for the *Fast DDS Spy*,
21+
including QoS fields always enforced by the *Fast DDS Spy* regardless of the profile.

docs/rst/user_manual/configuration.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,38 @@ The XML content must follow the same format as an XML file and will be loaded as
6161
dds-profile: "participant_profile"
6262
6363
64+
.. _user_manual_configuration_xml_endpoint_profiles:
65+
66+
Endpoint profiles
67+
^^^^^^^^^^^^^^^^^
68+
69+
Profiles named after a topic are automatically applied to :term:`DataReader` endpoints
70+
when they are created for that topic.
71+
When the |spy| creates a :term:`DataReader` for a topic, it looks for a loaded XML profile
72+
whose name matches the topic name.
73+
If a matching profile is found, the endpoint is configured using that profile's QoS, giving the user full
74+
control over fields such as history, memory policy, transport, etc.
75+
If no matching profile exists, the endpoint falls back to default QoS with values derived from the YAML configuration.
76+
77+
.. note::
78+
79+
Certain QoS are always enforced by the *Fast DDS Spy* regardless of the XML profile:
80+
``expects_inline_qos`` on DataReaders for keyed topics.
81+
82+
The following example loads a profile named ``my_topic`` that will be automatically applied when creating
83+
endpoints for a topic of that name:
84+
85+
.. code-block:: xml
86+
87+
<dds>
88+
<profiles>
89+
<data_reader profile_name="my_topic">
90+
<historyMemoryPolicy>DYNAMIC</historyMemoryPolicy>
91+
</data_reader>
92+
</profiles>
93+
</dds>
94+
95+
6496
.. _user_manual_configuration_dds__topic_filtering:
6597

6698
Topic Filtering

0 commit comments

Comments
 (0)