iox-#51: review findings

Signed-off-by: Poehnl Michael (CC-AD/ESW1) <[email protected]>

Author: budrus

iceoryx_posh/include/iceoryx_posh/internal/popo/base_port.hpp

@@ -14,8 +14,8 @@
 
 #pragma once
 
-#include "iceoryx_posh/internal/popo/base_port_data.hpp"
 #include "iceoryx_posh/iceoryx_posh_types.hpp"
+#include "iceoryx_posh/internal/popo/base_port_data.hpp"
 
 namespace iox
 {
@@ -57,31 +57,32 @@ class BasePort
     operator bool() const;
 
     /// @brief Reads Type of actual CaPro Port (sender/receiver...)
-    /// @param              Nothing
     /// @return m_portType  Type of Port in struct BasePortType
     BasePortType getPortType() const noexcept;
 
     /// @brief Reads Type of actual CaPro Port (sender/receiver...)
-    /// @param              Nothing
     /// @return m_portType  Type of Port in struct BasePortType
     capro::ServiceDescription getCaProServiceDescription() const noexcept;
 
     /// @brief Gets Application Name for the active port
-    /// @param              Nothing
     /// @return             Application name as String
     cxx::CString100 getApplicationName() const noexcept;
 
-
     /// @brief Gets Interface Name for the active port
-    /// @param              Nothing
     /// @return             Interface name as enum value
     Interfaces getInterface() const noexcept;
 
     /// @brief Gets Id of thethe active port
-    /// @param              Nothing
     /// @return             UniqueId name as Integer
     uint64_t getUniqueID() const noexcept;
 
+    /// @brief Indicate that this port can be destroyed
+    void destroy() noexcept;
+
+    /// @brief Checks whether port can be destroyed
+    /// @return             true if it shall be destroyed, false if not
+    bool toBeDestroyed() const noexcept;
+
   protected:
     const MemberType_t* getMembers() const noexcept;
     MemberType_t* getMembers() noexcept;

iceoryx_posh/include/iceoryx_posh/internal/popo/base_port_data.hpp

@@ -76,7 +76,7 @@ struct BasePortData
 
     static std::atomic<uint64_t> s_uniqueIdCounter;
     std::atomic<uint64_t> m_uniqueId{0};
-    std::atomic_bool m_tobeDestroyed{false};
+    std::atomic_bool m_toBeDestroyed{false};
 
     iox::relative_ptr<runtime::RunnableData> m_runnable;
 };

iceoryx_posh/include/iceoryx_posh/internal/popo/receiver_port.hpp

@@ -66,8 +66,6 @@ class ReceiverPort : public BasePort
     void unsubscribe();
     bool isSubscribed() const;
     SubscribeState getSubscribeState() const;
-    void destroy();
-    bool tobeDestroyed() const;
 
     // (only) from delivery FiFo to Cache
     virtual bool getChunk(const mepoo::ChunkHeader*& f_chunkHeader) noexcept;

iceoryx_posh/include/iceoryx_posh/internal/popo/sender_port.hpp

@@ -45,8 +45,6 @@ class SenderPort : public BasePort
     void freeChunk(mepoo::ChunkHeader* const chunkHeader);
     void activate();
     void deactivate();
-    void destroy();
-    bool tobeDestroyed() const;
     bool hasSubscribers();
     void forwardChunk(mepoo::SharedChunk chunk);
     MemberType_t::Throughput getThroughput() const;

iceoryx_posh/source/popo/base_port.cpp

@@ -74,5 +74,15 @@ BasePort::operator bool() const
     return m_basePortDataPtr != nullptr;
 }
 
+void BasePort::destroy() noexcept
+{
+    getMembers()->m_toBeDestroyed.store(true, std::memory_order_relaxed);
+}
+
+bool BasePort::toBeDestroyed() const noexcept
+{
+    return getMembers()->m_toBeDestroyed.load(std::memory_order_relaxed);
+}
+
 } // namespace popo
 } // namespace iox

iceoryx_posh/source/popo/receiver_port.cpp

@@ -189,17 +189,6 @@ SubscribeState ReceiverPort::getSubscribeState() const
     return getMembers()->m_subscriptionState.load(std::memory_order_relaxed);
 }
 
-void ReceiverPort::destroy()
-{
-    getMembers()->m_tobeDestroyed.store(true, std::memory_order_relaxed);
-}
-
-bool ReceiverPort::tobeDestroyed() const
-{
-    return getMembers()->m_tobeDestroyed.load(std::memory_order_relaxed);
-}
-
-
 bool ReceiverPort::getChunk(const mepoo::ChunkHeader*& f_chunkHeader) noexcept
 {
     mepoo::SharedChunk l_chunk;

iceoryx_posh/source/popo/sender_port.cpp

@@ -298,16 +298,6 @@ void SenderPort::deactivate()
     }
 }
 
-void SenderPort::destroy()
-{
-    getMembers()->m_tobeDestroyed.store(true, std::memory_order_relaxed);
-}
-
-bool SenderPort::tobeDestroyed() const
-{
-    return getMembers()->m_tobeDestroyed.load(std::memory_order_relaxed);
-}
-
 bool SenderPort::hasSubscribers()
 {
     return getMembers()->m_receiverHandler.appContext().hasReceivers();

iceoryx_posh/source/roudi/shared_memory_manager.cpp

@@ -118,7 +118,7 @@ void SharedMemoryManager::handleSenderPorts()
             sendToAllMatchingInterfacePorts(caproMessage, l_senderPort.getInterface());
         }
         // check if we have to destroy this sender port
-        if (l_senderPort.tobeDestroyed())
+        if (l_senderPort.toBeDestroyed())
         {
             destroySenderPort(l_senderPortData);
         }
@@ -147,7 +147,7 @@ void SharedMemoryManager::handleReceiverPorts()
             }
         }
         // check if we have to destroy this sender port
-        if (l_receiverPort.tobeDestroyed())
+        if (l_receiverPort.toBeDestroyed())
         {
             destroyReceiverPort(l_receiverPortData);
         }
@@ -425,7 +425,7 @@ void SharedMemoryManager::destroySenderPort(SenderPortType::MemberType_t* const
     removeEntryFromServiceRegistry(serviceDescription.getServiceIDString(), serviceDescription.getInstanceIDString());
     senderPort.cleanup();
 
-    capro::CaproMessage message(capro::CaproMessageType::STOP_OFFER, serviceDescription);
+    const capro::CaproMessage message(capro::CaproMessageType::STOP_OFFER, serviceDescription);
     m_portIntrospection.reportMessage(message);
 
     sendToAllMatchingReceiverPorts(message, senderPort);
@@ -434,7 +434,7 @@ void SharedMemoryManager::destroySenderPort(SenderPortType::MemberType_t* const
     m_portIntrospection.removeSender(senderPort.getApplicationName(), serviceDescription);
 
     // delete sender impl from list after StopOffer was processed
-    MiddlewareShm* const shm = m_ShmInterface.getShmInterface();
+    const auto shm = m_ShmInterface.getShmInterface();
     shm->m_senderPortMembers.erase(senderPortData);
     DEBUG_PRINTF("Destroyed SenderPortImpl\n");
 }
@@ -455,7 +455,7 @@ void SharedMemoryManager::destroyReceiverPort(ReceiverPortType::MemberType_t* co
     m_portIntrospection.removeReceiver(receiverPort.getApplicationName(), serviceDescription);
 
     // delete receiver impl from list after unsubscribe was processed
-    MiddlewareShm* const shm = m_ShmInterface.getShmInterface();
+    const auto shm = m_ShmInterface.getShmInterface();
     shm->m_receiverPortMembers.erase(receiverPortData);
     DEBUG_PRINTF("Destroyed ReceiverPortImpl\n");
 }