Add non-throwing getters for socket info (#4319)

* Refs #20262: Added non-throwing asio calls Signed-off-by: Jesus Perez <jesusperez@eprosima.com> * Refs #20262: Uncrustify Signed-off-by: Jesus Perez <jesusperez@eprosima.com> * Refs #20262: Apply suggestions Signed-off-by: Jesus Perez <jesusperez@eprosima.com> * Refs #20262: Apply suggestions Signed-off-by: Jesus Perez <jesusperez@eprosima.com> --------- Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
eProsima · Feb 8, 2024 · 6b484da · 6b484da
1 parent 7adc833
commit 6b484da
Show file tree

Hide file tree

Showing 9 changed files with 111 additions and 2 deletions.
diff --git a/src/cpp/rtps/transport/TCPChannelResource.h b/src/cpp/rtps/transport/TCPChannelResource.h
@@ -130,10 +130,36 @@ class TCPChannelResource : public ChannelResource
             size_t size,
             asio::error_code& ec) = 0;
 
+    /**
+     * @brief Gets the remote endpoint of the socket connection.
+     * @throws Exception on failure.
+     * @return asio::ip::tcp::endpoint of the remote endpoint.
+     */
     virtual asio::ip::tcp::endpoint remote_endpoint() const = 0;
 
+    /**
+     * @brief Gets the local endpoint of the socket connection.
+     * @throws Exception on failure.
+     * @return asio::ip::tcp::endpoint of the local endpoint.
+     */
     virtual asio::ip::tcp::endpoint local_endpoint() const = 0;
 
+    /**
+     * @brief Gets the remote endpoint, setting error code if any.
+     * @param ec Set to indicate what error occurred, if any.
+     * @return asio::ip::tcp::endpoint of the remote endpoint or returns a default-constructed endpoint object if an error occurred.
+     */
+    virtual asio::ip::tcp::endpoint remote_endpoint(
+            asio::error_code& ec) const = 0;
+
+    /**
+     * @brief Gets the local endpoint, setting error code if any.
+     * @param ec Set to indicate what error occurred, if any.
+     * @return asio::ip::tcp::endpoint of the remote endpoint or returns a default-constructed endpoint object if an error occurred.
+     */
+    virtual asio::ip::tcp::endpoint local_endpoint(
+            asio::error_code& ec) const = 0;
+
     virtual void set_options(
             const TCPTransportDescriptor* options) = 0;
 

diff --git a/src/cpp/rtps/transport/TCPChannelResourceBasic.cpp b/src/cpp/rtps/transport/TCPChannelResourceBasic.cpp
@@ -181,7 +181,18 @@ asio::ip::tcp::endpoint TCPChannelResourceBasic::remote_endpoint() const
 
 asio::ip::tcp::endpoint TCPChannelResourceBasic::local_endpoint() const
 {
-    std::error_code ec;
+    return socket_->local_endpoint();
+}
+
+asio::ip::tcp::endpoint TCPChannelResourceBasic::remote_endpoint(
+        asio::error_code& ec) const
+{
+    return socket_->remote_endpoint(ec);
+}
+
+asio::ip::tcp::endpoint TCPChannelResourceBasic::local_endpoint(
+        asio::error_code& ec) const
+{
     return socket_->local_endpoint(ec);
 }
 

diff --git a/src/cpp/rtps/transport/TCPChannelResourceBasic.h b/src/cpp/rtps/transport/TCPChannelResourceBasic.h
@@ -65,9 +65,16 @@ class TCPChannelResourceBasic : public TCPChannelResource
             size_t size,
             asio::error_code& ec) override;
 
+    // Throwing asio calls
     asio::ip::tcp::endpoint remote_endpoint() const override;
     asio::ip::tcp::endpoint local_endpoint() const override;
 
+    // Non-throwing asio calls
+    asio::ip::tcp::endpoint remote_endpoint(
+            asio::error_code& ec) const override;
+    asio::ip::tcp::endpoint local_endpoint(
+            asio::error_code& ec) const override;
+
     void set_options(
             const TCPTransportDescriptor* options) override;
 

diff --git a/src/cpp/rtps/transport/TCPChannelResourceSecure.cpp b/src/cpp/rtps/transport/TCPChannelResourceSecure.cpp
@@ -265,6 +265,18 @@ asio::ip::tcp::endpoint TCPChannelResourceSecure::local_endpoint() const
     return secure_socket_->lowest_layer().local_endpoint();
 }
 
+asio::ip::tcp::endpoint TCPChannelResourceSecure::remote_endpoint(
+        asio::error_code& ec) const
+{
+    return secure_socket_->lowest_layer().remote_endpoint(ec);
+}
+
+asio::ip::tcp::endpoint TCPChannelResourceSecure::local_endpoint(
+        asio::error_code& ec) const
+{
+    return secure_socket_->lowest_layer().local_endpoint(ec);
+}
+
 void TCPChannelResourceSecure::set_options(
         const TCPTransportDescriptor* options)
 {

diff --git a/src/cpp/rtps/transport/TCPChannelResourceSecure.h b/src/cpp/rtps/transport/TCPChannelResourceSecure.h
@@ -65,9 +65,16 @@ class TCPChannelResourceSecure : public TCPChannelResource
             size_t size,
             asio::error_code& ec) override;
 
+    // Throwing asio calls
     asio::ip::tcp::endpoint remote_endpoint() const override;
     asio::ip::tcp::endpoint local_endpoint() const override;
 
+    // Non-throwing asio calls
+    asio::ip::tcp::endpoint remote_endpoint(
+            asio::error_code& ec) const override;
+    asio::ip::tcp::endpoint local_endpoint(
+            asio::error_code& ec) const override;
+
     void set_options(
             const TCPTransportDescriptor* options) override;
 

diff --git a/src/cpp/rtps/transport/TCPTransportInterface.cpp b/src/cpp/rtps/transport/TCPTransportInterface.cpp
@@ -260,6 +260,19 @@ void TCPTransportInterface::clean()
     }
 }
 
+Locator TCPTransportInterface::remote_endpoint_to_locator(
+        const std::shared_ptr<TCPChannelResource>& channel) const
+{
+    Locator locator;
+    asio::error_code ec;
+    endpoint_to_locator(channel->remote_endpoint(ec), locator);
+    if (ec)
+    {
+        LOCATOR_INVALID(locator);
+    }
+    return locator;
+}
+
 void TCPTransportInterface::bind_socket(
         std::shared_ptr<TCPChannelResource>& channel)
 {
@@ -898,10 +911,11 @@ void TCPTransportInterface::perform_listen_operation(
     if (rtcp_message_manager)
     {
         channel = channel_weak.lock();
-        endpoint_to_locator(channel->remote_endpoint(), remote_locator);
 
         if (channel)
         {
+            remote_locator = remote_endpoint_to_locator(channel);
+
             uint32_t port = channel->local_endpoint().port();
             set_name_to_current_thread("dds.tcp.%u", port);
 
@@ -1178,6 +1192,10 @@ bool TCPTransportInterface::Receive(
                     }
                     else
                     {
+                        if (!IsLocatorValid(remote_locator))
+                        {
+                            remote_locator = remote_endpoint_to_locator(channel);
+                        }
                         IPLocator::setLogicalPort(remote_locator, tcp_header.logical_port);
                         EPROSIMA_LOG_INFO(RTCP_MSG_IN, "[RECEIVE] From: " << remote_locator \
                                                                           << " - " << receive_buffer_size << " bytes.");

diff --git a/src/cpp/rtps/transport/TCPTransportInterface.h b/src/cpp/rtps/transport/TCPTransportInterface.h
@@ -188,6 +188,12 @@ class TCPTransportInterface : public TransportInterface
             const asio::ip::tcp::endpoint& endpoint,
             Locator& locator) const = 0;
 
+    /**
+     * Converts a remote endpoint to a locator if possible. Otherwise, it sets an invalid locator.
+     */
+    Locator remote_endpoint_to_locator(
+            const std::shared_ptr<TCPChannelResource>& channel) const;
+
     /**
      * Shutdown method to close the connections of the transports.
      */

diff --git a/test/unittest/transport/mock/MockTCPChannelResource.cpp b/test/unittest/transport/mock/MockTCPChannelResource.cpp
@@ -67,6 +67,22 @@ asio::ip::tcp::endpoint MockTCPChannelResource::local_endpoint() const
     return ep;
 }
 
+asio::ip::tcp::endpoint MockTCPChannelResource::remote_endpoint(
+        asio::error_code& ec) const
+{
+    ec = asio::error_code();  // Indicate no error
+    asio::ip::tcp::endpoint ep;
+    return ep;
+}
+
+asio::ip::tcp::endpoint MockTCPChannelResource::local_endpoint(
+        asio::error_code& ec) const
+{
+    ec = asio::error_code();  // Indicate no error
+    asio::ip::tcp::endpoint ep;
+    return ep;
+}
+
 void MockTCPChannelResource::set_options(
         const TCPTransportDescriptor*)
 {

diff --git a/test/unittest/transport/mock/MockTCPChannelResource.h b/test/unittest/transport/mock/MockTCPChannelResource.h
@@ -59,6 +59,12 @@ class MockTCPChannelResource : public TCPChannelResource
 
     asio::ip::tcp::endpoint local_endpoint() const override;
 
+    asio::ip::tcp::endpoint remote_endpoint(
+            asio::error_code& ec) const override;
+
+    asio::ip::tcp::endpoint local_endpoint(
+            asio::error_code& ec) const override;
+
     void set_options(
             const TCPTransportDescriptor* options) override;