[21808] DataWriter/Reader `get_matched_publication/subscription()` Tests & Feature 3.x #5312

Mario-DL · 2024-10-09T08:20:08Z

Description

This PR is a forward port of #5284, implementing the following APIs

DDS

DataWriter::get_matched_subscriptions()
DataWriter::get_matched_subscription_data()
DataReader::get_matched_publications()
DataReader::get_matched_publication_data()

RTPS

RTPSParticipant::get_publication_info()
RTPSParticipant::get_subscription_info()
RTPSReader::matched_writers_guids()
RTPSWriter::matched_readers_guids()

In the 3.x series.

Related PRs:

[21808] Update DataWriter/Reader get_matched_publication/subscription...() (2.x) API tests Fast-DDS-python#188

Contributor Checklist

Commit messages follow the project guidelines.
The code follows the style guidelines of this project.
Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
Any new/modified methods have been properly documented using Doxygen.
N/A Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
Changes are backport compatible: they do NOT break ABI nor change library core behavior.
Changes are API compatible.
New feature has been added to the versions.md file (if applicable).
N/A New feature has been documented/Current behavior is correctly described in the documentation.
N/A Applicable backports have been included in the description.

Reviewer Checklist

The PR has a milestone assigned.
The title and description correctly express the PR's purpose.
Check contributor checklist is correct.
If this is a critical bug fix, backports to the critical-only supported branches have been requested.
Check CI results: changes do not issue any warning.
Check CI results: failing tests are unrelated with the changes.

richiware

Also pending a PR to Python bindings.

richiware · 2024-10-17T08:25:34Z

src/cpp/fastdds/publisher/DataWriterImpl.hpp

+     * @brief Retrieves in a subscription associated with the DataWriter
+     *
+     * @param[out] subscription_data subscription data struct
+     * @param subscription_handle InstanceHandle_t of the subscription


Suggested change

* @param subscription_handle InstanceHandle_t of the subscription

* @param subscription_handle @ref InstanceHandle_t of the subscription

richiware · 2024-10-17T08:25:49Z

src/cpp/fastdds/publisher/DataWriterImpl.hpp

+     *
+     * @param[out] subscription_data subscription data struct
+     * @param subscription_handle InstanceHandle_t of the subscription
+     * @return RETCODE_BAD_PARAMETER if the DataWriter is not matched with


Suggested change

* @return RETCODE_BAD_PARAMETER if the DataWriter is not matched with

* @return @ref RETCODE_BAD_PARAMETER if the DataWriter is not matched with

richiware · 2024-10-17T08:26:00Z

src/cpp/fastdds/publisher/DataWriterImpl.hpp

+     * @param[out] subscription_data subscription data struct
+     * @param subscription_handle InstanceHandle_t of the subscription
+     * @return RETCODE_BAD_PARAMETER if the DataWriter is not matched with
+     * the given subscription handle, RETCODE_OK otherwise.


Suggested change

* the given subscription handle, RETCODE_OK otherwise.

* the given subscription handle, @ref RETCODE_OK otherwise.

richiware · 2024-10-17T08:26:53Z

src/cpp/fastdds/publisher/DataWriterImpl.hpp

+     * @brief Fills the given vector with the InstanceHandle_t of matched DataReaders
+     *
+     * @param[out] subscription_handles Vector where the InstanceHandle_t are returned
+     * @return RETCODE_OK if the operation succeeds.
+     *
+     * @note Returning an empty list is not an error, it returns RETCODE_OK.


Suggested change

* @brief Fills the given vector with the InstanceHandle_t of matched DataReaders

*

* @param[out] subscription_handles Vector where the InstanceHandle_t are returned

* @return RETCODE_OK if the operation succeeds.

*

* @note Returning an empty list is not an error, it returns RETCODE_OK.

* @brief Fills the given vector with the @ref InstanceHandle_t of matched DataReaders

*

* @param[out] subscription_handles Vector where the @ref InstanceHandle_t are returned

* @return @ref RETCODE_OK if the operation succeeds.

*

* @note Returning an empty list is not an error, it returns @ref RETCODE_OK.

richiware · 2024-10-17T08:27:41Z

src/cpp/fastdds/subscriber/DataReaderImpl.hpp

+     * @param publication_handle InstanceHandle_t of the publication
+     * @return RETCODE_BAD_PARAMETER if the DataReader is not matched with
+     * the given publication handle, RETCODE_OK otherwise.


Suggested change

* @param publication_handle InstanceHandle_t of the publication

* @return RETCODE_BAD_PARAMETER if the DataReader is not matched with

* the given publication handle, RETCODE_OK otherwise.

* @param publication_handle @ref InstanceHandle_t of the publication

* @return @ref RETCODE_BAD_PARAMETER if the DataReader is not matched with

* the given publication handle, @ref RETCODE_OK otherwise.

richiware · 2024-10-17T08:30:27Z

src/cpp/rtps/reader/StatelessReader.cpp

+    guids.reserve(matched_writers_.size());
+    for (const RemoteWriterInfo_t& writer : matched_writers_)
+    {
+        guids.push_back(writer.guid);


Suggested change

guids.push_back(writer.guid);

guids.emplace_back(writer.guid);

richiware · 2024-10-17T08:31:29Z

src/cpp/rtps/writer/StatefulWriter.cpp

+    for_matched_readers(matched_local_readers_, matched_datasharing_readers_, matched_remote_readers_,
+            [&guids](const ReaderProxy* reader)
+            {
+                guids.push_back(reader->guid());


Suggested change

guids.push_back(reader->guid());

guids.emplace_back(reader->guid());

richiware · 2024-10-17T08:31:54Z

src/cpp/rtps/writer/StatefulWriter.cpp

+        std::vector<GUID_t>& guids) const
+{
+    std::lock_guard<RecursiveTimedMutex> guard(mp_mutex);
+    guids.clear();


maybe we can reserve the space like in other methods

richiware · 2024-10-17T08:32:28Z

src/cpp/rtps/writer/StatelessWriter.cpp

+    for_matched_readers(matched_local_readers_, matched_datasharing_readers_, matched_remote_readers_,
+            [&guids](const ReaderLocator& reader)
+            {
+                guids.push_back(reader.remote_guid());


Suggested change

guids.push_back(reader.remote_guid());

guids.emplace_back(reader.remote_guid());

richiware · 2024-10-17T08:32:47Z

src/cpp/rtps/writer/StatelessWriter.cpp

+        std::vector<GUID_t>& guids) const
+{
+    std::lock_guard<RecursiveTimedMutex> guard(mp_mutex);
+    guids.clear();


maybe we can reserve previously like in other methods

… Test implementation 3.x Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

… Feature implementation 3.x Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Mario-DL added this to the v3.2.0 milestone Oct 9, 2024

Mario-DL mentioned this pull request Oct 9, 2024

[21808] Update DataWriter/Reader get_matched_publication/subscription...() (2.x) API tests eProsima/Fast-DDS-python#188

Open

6 tasks

Mario-DL requested review from richiprosima and removed request for richiprosima October 9, 2024 08:35

github-actions bot added the ci-pending PR which CI is running label Oct 9, 2024

Mario-DL requested review from richiprosima and removed request for richiprosima October 9, 2024 12:55

richiware self-requested a review October 17, 2024 08:03

richiware requested changes Oct 17, 2024

View reviewed changes

Mario-DL added 5 commits October 18, 2024 09:16

Refs #21808: DataWriter/Reader get_matched_publication/subscription()…

3721e60

… Test implementation 3.x Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Refs #21808: DataWriter/Reader get_matched_publication/subscription()…

3037151

… Feature implementation 3.x Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Refs #21808: versions.md

19cf823

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Refs #21808: Update UnsupportedData*Methods

a9444cc

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Refs #21808: Apply Ricardo's rev

7559328

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

Mario-DL force-pushed the feature/21808 branch from 23914aa to 7559328 Compare October 18, 2024 07:18

Mario-DL requested a review from richiware October 18, 2024 07:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[21808] DataWriter/Reader `get_matched_publication/subscription()` Tests & Feature 3.x #5312

[21808] DataWriter/Reader `get_matched_publication/subscription()` Tests & Feature 3.x #5312

Mario-DL commented Oct 9, 2024 •

edited

Loading

richiware left a comment

richiware Oct 17, 2024

richiware Oct 17, 2024

richiware Oct 17, 2024

richiware Oct 17, 2024

richiware Oct 17, 2024

richiware Oct 17, 2024

richiware Oct 17, 2024

richiware Oct 17, 2024

richiware Oct 17, 2024

richiware Oct 17, 2024

	* @param subscription_handle InstanceHandle_t of the subscription
	* @param subscription_handle @ref InstanceHandle_t of the subscription

	* @return RETCODE_BAD_PARAMETER if the DataWriter is not matched with
	* @return @ref RETCODE_BAD_PARAMETER if the DataWriter is not matched with

	* the given subscription handle, RETCODE_OK otherwise.
	* the given subscription handle, @ref RETCODE_OK otherwise.

	guids.push_back(writer.guid);
	guids.emplace_back(writer.guid);

	guids.push_back(reader->guid());
	guids.emplace_back(reader->guid());

	guids.push_back(reader.remote_guid());
	guids.emplace_back(reader.remote_guid());

[21808] DataWriter/Reader get_matched_publication/subscription() Tests & Feature 3.x #5312

Are you sure you want to change the base?

[21808] DataWriter/Reader get_matched_publication/subscription() Tests & Feature 3.x #5312

Conversation

Mario-DL commented Oct 9, 2024 • edited Loading

Description

Contributor Checklist

Reviewer Checklist

richiware left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

[21808] DataWriter/Reader `get_matched_publication/subscription()` Tests & Feature 3.x #5312

[21808] DataWriter/Reader `get_matched_publication/subscription()` Tests & Feature 3.x #5312

Mario-DL commented Oct 9, 2024 •

edited

Loading