iox-#27 Merge ConsumerTooSlowPolicy and SubscriberTooSlowPolicy

eclipse-iceoryx · Feb 9, 2022 · 33bcc14 · 33bcc14
1 parent 2bd74be
commit 33bcc14
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 23 deletions.
diff --git a/iceoryx_posh/include/iceoryx_posh/popo/port_queue_policies.hpp b/iceoryx_posh/include/iceoryx_posh/popo/port_queue_policies.hpp
@@ -23,13 +23,22 @@ namespace iox
 {
 namespace popo
 {
-/// @brief Used by publisher
-/// @todo iox-#27 replace with ConsumerTooSlowPolicy
-enum class SubscriberTooSlowPolicy : uint8_t
+/// @brief Used by producers how to adjust to slow consumer
+enum class ConsumerTooSlowPolicy : uint8_t
 {
-    WAIT_FOR_SUBSCRIBER,
+    /// Waits for the consumer it it's queue is full
+    WAIT_FOR_CONSUMER,
+    /// @deprecated Compatibility value for the legacy use with publisher only. Will be remove in a future release.
+    /// Please use `WAIT_FOR_CONSUMER` instead.
+    WAIT_FOR_SUBSCRIBER = WAIT_FOR_CONSUMER,
+    /// Discards the oldest data and pushes the newest one into the queue
     DISCARD_OLDEST_DATA
 };
+/// @deprecated Compatibility alias for the legacy use with publisher only. Will be remove in a future release.
+/// Please use `ConsumerTooSlowPolicy` instead.
+/// @todo iox-#27 decide whether this should be hard deprecated with [[deprecated]] attribute for the next release
+using SubscriberTooSlowPolicy = ConsumerTooSlowPolicy;
+
 /// @brief Used by consumers to request a specific behavior from the producer
 enum class QueueFullPolicy : uint8_t
 {
@@ -42,15 +51,6 @@ enum class QueueFullPolicy : uint8_t
     DISCARD_OLDEST_DATA
 };
 
-/// @brief Used by producers how to adjust to slow consumer
-enum class ConsumerTooSlowPolicy : uint8_t
-{
-    /// Waits for the consumer it it's queue is full
-    WAIT_FOR_CONSUMER,
-    /// Discards the oldest data and pushes the newest one into the queue
-    DISCARD_OLDEST_DATA
-};
-
 } // namespace popo
 } // namespace iox
 #endif // IOX_POSH_POPO_PORT_QUEUE_POLICIES_HPP
diff --git a/iceoryx_posh/source/popo/ports/client_port_data.cpp b/iceoryx_posh/source/popo/ports/client_port_data.cpp
@@ -33,10 +33,7 @@ ClientPortData::ClientPortData(const capro::ServiceDescription& serviceDescripti
                                mepoo::MemoryManager* const memoryManager,
                                const mepoo::MemoryInfo& memoryInfo) noexcept
     : BasePortData(serviceDescription, runtimeName, clientOptions.nodeName)
-    , m_chunkSenderData(memoryManager,
-                        static_cast<SubscriberTooSlowPolicy>(clientOptions.serverTooSlowPolicy),
-                        HISTORY_CAPACITY_ZERO,
-                        memoryInfo)
+    , m_chunkSenderData(memoryManager, clientOptions.serverTooSlowPolicy, HISTORY_CAPACITY_ZERO, memoryInfo)
     , m_chunkReceiverData(getResponseQueueType(clientOptions.responseQueueFullPolicy),
                           clientOptions.responseQueueFullPolicy)
     , m_connectRequested(clientOptions.connectOnCreate)

diff --git a/iceoryx_posh/source/popo/ports/server_port_data.cpp b/iceoryx_posh/source/popo/ports/server_port_data.cpp
@@ -21,7 +21,6 @@ namespace iox
 {
 namespace popo
 {
-/// @todo iox-#27 remove when the port queue policies are consolidated
 cxx::VariantQueueTypes getRequestQueueType(const QueueFullPolicy policy) noexcept
 {
     return policy == QueueFullPolicy::DISCARD_OLDEST_DATA ? cxx::VariantQueueTypes::SoFi_MultiProducerSingleConsumer
@@ -34,10 +33,7 @@ ServerPortData::ServerPortData(const capro::ServiceDescription& serviceDescripti
                                mepoo::MemoryManager* const memoryManager,
                                const mepoo::MemoryInfo& memoryInfo) noexcept
     : BasePortData(serviceDescription, runtimeName, serverOptions.nodeName)
-    , m_chunkSenderData(memoryManager,
-                        static_cast<SubscriberTooSlowPolicy>(serverOptions.clientTooSlowPolicy),
-                        HISTORY_REQUEST_OF_ZERO,
-                        memoryInfo)
+    , m_chunkSenderData(memoryManager, serverOptions.clientTooSlowPolicy, HISTORY_REQUEST_OF_ZERO, memoryInfo)
     , m_chunkReceiverData(getRequestQueueType(serverOptions.requestQueueFullPolicy),
                           serverOptions.requestQueueFullPolicy)
     , m_offeringRequested(serverOptions.offerOnCreate)

diff --git a/iceoryx_posh/source/popo/ports/server_port_roudi.cpp b/iceoryx_posh/source/popo/ports/server_port_roudi.cpp
@@ -41,7 +41,7 @@ ServerPortRouDi::MemberType_t* ServerPortRouDi::getMembers() noexcept
 
 ConsumerTooSlowPolicy ServerPortRouDi::getClientTooSlowPolicy() const noexcept
 {
-    return static_cast<ConsumerTooSlowPolicy>(getMembers()->m_chunkSenderData.m_subscriberTooSlowPolicy);
+    return getMembers()->m_chunkSenderData.m_subscriberTooSlowPolicy;
 }
 
 cxx::optional<capro::CaproMessage> ServerPortRouDi::tryGetCaProMessage() noexcept