PubConfig -> Publisher::Configuration

SHMConfig -> Publisher::SHM::Configuration UDPConfig -> Publisher::UDP::Configuration TCPConfig -> Publisher::TCP::Configuration
eclipse-ecal · May 6, 2024 · eb93882 · eb93882
1 parent 6818c2c
commit eb93882
Show file tree

Hide file tree

Showing 31 changed files with 106 additions and 91 deletions.
diff --git a/ecal/core/include/ecal/ecal_publisher.h b/ecal/core/include/ecal/ecal_publisher.h
@@ -84,15 +84,15 @@ namespace eCAL
      * @param data_type_info_  Topic data type information (encoding, type, descriptor).
      * @param config_          Optional configuration parameters.
     **/
-    ECAL_API CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubConfig& config_ = {});
+    ECAL_API CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const Publisher::Configuration& config_ = {});
 
     /**
      * @brief Constructor.
      *
      * @param topic_name_   Unique topic name.
      * @param config_       Optional configuration parameters.
     **/
-    ECAL_API explicit CPublisher(const std::string& topic_name_, const PubConfig& config_ = {});
+    ECAL_API explicit CPublisher(const std::string& topic_name_, const Publisher::Configuration& config_ = {});
 
     /**
      * @brief Destructor. 
@@ -128,7 +128,7 @@ namespace eCAL
      *
      * @return  True if it succeeds, false if it fails.
     **/
-    ECAL_API bool Create(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubConfig& config_ = {});
+    ECAL_API bool Create(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const Publisher::Configuration& config_ = {});
 
     /**
      * @brief Creates this object.

diff --git a/ecal/core/include/ecal/ecal_publisher_config.h b/ecal/core/include/ecal/ecal_publisher_config.h
@@ -30,37 +30,49 @@
 
 namespace eCAL
 {
-  struct ECAL_API SHMPubConfig
+  namespace Publisher
   {
-    TLayer::eSendMode  send_mode               = TLayer::smode_auto;  //!< shm layer send mode (default auto)
-    bool               zero_copy_mode          = false;               //!< enable zero copy shared memory transport mode
-    int                acknowledge_timeout_ms  = 0;                   /*!< force connected subscribers to send acknowledge event after processing the message
-                                                                            the publisher send call is blocked on this event with this timeout (0 == no handshake) */
-    size_t             memfile_min_size_bytes  = 4096;                //!< default memory file size for new publisher
-    size_t             memfile_reserve_percent = 50;                  //!< dynamic file size reserve before recreating memory file if topic size changes
-    size_t             memfile_buffer_count    = 1;                   //!< maximum number of used buffers (needs to be greater than 1, default = 1)
-  };
+    namespace SHM
+    {
+      struct ECAL_API Configuration
+      {
+        TLayer::eSendMode  send_mode               = TLayer::smode_auto;  //!< shm layer send mode (default auto)
+        bool               zero_copy_mode          = false;               //!< enable zero copy shared memory transport mode
+        int                acknowledge_timeout_ms  = 0;                   /*!< force connected subscribers to send acknowledge event after processing the message
+                                                                                 the publisher send call is blocked on this event with this timeout (0 == no handshake) */
+        size_t             memfile_min_size_bytes  = 4096;                //!< default memory file size for new publisher
+        size_t             memfile_reserve_percent = 50;                  //!< dynamic file size reserve before recreating memory file if topic size changes
+        size_t             memfile_buffer_count    = 1;                   //!< maximum number of used buffers (needs to be greater than 1, default = 1)
+      };
+    }
 
-  struct ECAL_API UDPPubConfig
-  {
-    TLayer::eSendMode  send_mode               = TLayer::smode_auto;  //!< udp layer send mode (default auto)
-    int                sndbuf_size_bytes       = (5*1024*1024);       //!< udp send buffer size in bytes (default 5MB)
-  };
+    namespace UDP
+    {
+      struct ECAL_API Configuration
+      {
+        TLayer::eSendMode  send_mode               = TLayer::smode_auto;  //!< udp layer send mode (default auto)
+        int                sndbuf_size_bytes       = (5*1024*1024);       //!< udp send buffer size in bytes (default 5MB)
+      };
+    }
 
-  struct ECAL_API TCPPubConfig
-  {
-    TLayer::eSendMode  send_mode               = TLayer::smode_off;   //!<  tcp layer send mode (default off)
-  };
+    namespace TCP
+    {
+      struct ECAL_API Configuration
+      {
+        TLayer::eSendMode  send_mode               = TLayer::smode_off;   //!< tcp layer send mode (default off)
+      };
+    }
 
-  struct ECAL_API PubConfig
-  {
-    PubConfig();
+    struct ECAL_API Configuration
+    {
+      Configuration();
 
-    SHMPubConfig shm;
-    UDPPubConfig udp;
-    TCPPubConfig tcp;
+      SHM::Configuration shm;
+      UDP::Configuration udp;
+      TCP::Configuration tcp;
 
-    bool share_topic_type        = true;
-    bool share_topic_description = true;
-  };
+      bool share_topic_type                      = true;                //!< share topic type via registration
+      bool share_topic_description               = true;                //!< share topic description via registration
+    };
+  }
 }
diff --git a/ecal/core/include/ecal/msg/capnproto/publisher.h b/ecal/core/include/ecal/msg/capnproto/publisher.h
@@ -101,7 +101,7 @@ namespace eCAL
       * @param topic_name_  Unique topic name.
       * @param config_      Optional configuration parameters.
       **/
-      CPublisher(const std::string& topic_name_, const eCAL::PubConfig& config_ = {})
+      CPublisher(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {})
         : eCAL::CPublisher(topic_name_, GetDataTypeInformation(), config_)
         , builder(std::make_unique<capnp::MallocMessageBuilder>())
         , root_builder(builder->initRoot<message_type>())
@@ -150,7 +150,7 @@ namespace eCAL
       *
       * @return  True if it succeeds, false if it fails.
       **/
-      bool Create(const std::string& topic_name_, const eCAL::PubConfig& config_ = {})
+      bool Create(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {})
       {
         return(eCAL::CPublisher::Create(topic_name_, GetDataTypeInformation(), config_));
       }

diff --git a/ecal/core/include/ecal/msg/flatbuffers/publisher.h b/ecal/core/include/ecal/msg/flatbuffers/publisher.h
@@ -53,7 +53,7 @@ namespace eCAL
        * @param topic_name_  Unique topic name.
        * @param config_      Optional configuration parameters.
       **/
-      CPublisher(const std::string& topic_name_, const eCAL::PubConfig& config_ = {}) : CMsgPublisher<T>(topic_name_, GetDataTypeInformation(), config_)
+      CPublisher(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {}) : CMsgPublisher<T>(topic_name_, GetDataTypeInformation(), config_)
       {
       }
 
@@ -85,7 +85,7 @@ namespace eCAL
        *
        * @return  True if it succeeds, false if it fails.
       **/
-      bool Create(const std::string& topic_name_, const eCAL::PubConfig& config_ = {})
+      bool Create(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {})
       {
         return(CMsgPublisher<T>::Create(topic_name_, GetDataTypeInformation(), config_));
       }

diff --git a/ecal/core/include/ecal/msg/messagepack/publisher.h b/ecal/core/include/ecal/msg/messagepack/publisher.h
@@ -56,7 +56,7 @@ namespace eCAL
        * @param topic_name_  Unique topic name.
        * @param config_      Optional configuration parameters.
       **/
-      CPublisher(const std::string& topic_name_, const eCAL::PubConfig& config_ = {}) : CMsgPublisher<T>(topic_name_, GetDataTypeInformation(), config_)
+      CPublisher(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {}) : CMsgPublisher<T>(topic_name_, GetDataTypeInformation(), config_)
       {
       }
 
@@ -88,7 +88,7 @@ namespace eCAL
        *
        * @return  True if it succeeds, false if it fails.
       **/
-      bool Create(const std::string& topic_name_, const eCAL::PubConfig& config_ = {})
+      bool Create(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {})
       {
         return(CMsgPublisher<T>::Create(topic_name_, GetDataTypeInformation(), config_));
       }

diff --git a/ecal/core/include/ecal/msg/protobuf/dynamic_publisher.h b/ecal/core/include/ecal/msg/protobuf/dynamic_publisher.h
@@ -62,7 +62,7 @@ namespace eCAL
        * @param msg_         Protobuf message object.
        * @param config_      Optional configuration parameters.
       **/
-      CDynamicPublisher(const std::string& topic_name_, const std::shared_ptr<google::protobuf::Message>& msg_, const eCAL::PubConfig& config_ = {})
+      CDynamicPublisher(const std::string& topic_name_, const std::shared_ptr<google::protobuf::Message>& msg_, const eCAL::Publisher::Configuration& config_ = {})
         : CMsgPublisher<google::protobuf::Message>(topic_name_, GetTopicInformationFromMessage(msg_.get()), config_)
         , m_msg{ msg_ } {}
 

diff --git a/ecal/core/include/ecal/msg/protobuf/publisher.h b/ecal/core/include/ecal/msg/protobuf/publisher.h
@@ -107,7 +107,7 @@ namespace eCAL
       // where the vtable is not created yet, or it's destructed.
       // Probably we can handle the Message publishers differently. One message publisher class and then one class for payloads and getting type
       // descriptor information.
-      explicit CPublisher(const std::string& topic_name_, const eCAL::PubConfig& config_ = {}) : eCAL::CPublisher(topic_name_, CPublisher::GetDataTypeInformation(), config_)
+      explicit CPublisher(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {}) : eCAL::CPublisher(topic_name_, CPublisher::GetDataTypeInformation(), config_)
       {
       }
 
@@ -144,7 +144,7 @@ namespace eCAL
        *
        * @return  True if it succeeds, false if it fails.
       **/
-      bool Create(const std::string& topic_name_, const eCAL::PubConfig& config_ = {})
+      bool Create(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {})
       {
         return(eCAL::CPublisher::Create(topic_name_, GetDataTypeInformation(), config_));
       }

diff --git a/ecal/core/include/ecal/msg/publisher.h b/ecal/core/include/ecal/msg/publisher.h
@@ -63,7 +63,7 @@ namespace eCAL
      * @param data_type_info_  Topic data type information (encoding, type, descriptor).
      * @param config_          Optional configuration parameters.
     **/
-    CMsgPublisher(const std::string& topic_name_, const struct SDataTypeInformation& data_type_info_, const PubConfig& config_ = {}) : CPublisher(topic_name_, data_type_info_, config_)
+    CMsgPublisher(const std::string& topic_name_, const struct SDataTypeInformation& data_type_info_, const Publisher::Configuration& config_ = {}) : CPublisher(topic_name_, data_type_info_, config_)
     {
     }
 
@@ -74,7 +74,7 @@ namespace eCAL
      * @param topic_name_  Unique topic name.
      * @param config_      Optional configuration parameters.
     **/
-    explicit CMsgPublisher(const std::string& topic_name_, const PubConfig& config_ = {}) : CMsgPublisher(topic_name_, GetDataTypeInformation(), config_)
+    explicit CMsgPublisher(const std::string& topic_name_, const Publisher::Configuration& config_ = {}) : CMsgPublisher(topic_name_, GetDataTypeInformation(), config_)
     {
     }
 
@@ -109,7 +109,7 @@ namespace eCAL
      *
      * @return  True if it succeeds, false if it fails.
     **/
-    bool Create(const std::string& topic_name_, const struct SDataTypeInformation& data_type_info_, const PubConfig& config_ = {})
+    bool Create(const std::string& topic_name_, const struct SDataTypeInformation& data_type_info_, const Publisher::Configuration& config_ = {})
     {
       return(CPublisher::Create(topic_name_, data_type_info_, config_));
     }

diff --git a/ecal/core/include/ecal/msg/string/publisher.h b/ecal/core/include/ecal/msg/string/publisher.h
@@ -60,7 +60,7 @@ namespace eCAL
 
       // call the function via its class because it's a virtual function that is called in constructor/destructor,-
       // where the vtable is not created yet, or it's destructed.
-      explicit CPublisher(const std::string& topic_name_, const eCAL::PubConfig& config_ = {}) : CMsgPublisher<T>(topic_name_, GetDataTypeInformation(), config_)
+      explicit CPublisher(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {}) : CMsgPublisher<T>(topic_name_, GetDataTypeInformation(), config_)
       {
       }
 
@@ -92,7 +92,7 @@ namespace eCAL
        *
        * @return  True if it succeeds, false if it fails.
       **/
-      bool Create(const std::string& topic_name_, const eCAL::PubConfig& config_ = {})
+      bool Create(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {})
       {
         return(CMsgPublisher<T>::Create(topic_name_, GetDataTypeInformation(), config_));
       }

diff --git a/ecal/core/src/pubsub/ecal_publisher.cpp b/ecal/core/src/pubsub/ecal_publisher.cpp
@@ -43,13 +43,13 @@ namespace eCAL
   {
   }
 
-  CPublisher::CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubConfig& config_)
+  CPublisher::CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const Publisher::Configuration& config_)
     : CPublisher()
   {
     CPublisher::Create(topic_name_, data_type_info_, config_);
   }
 
-  CPublisher::CPublisher(const std::string& topic_name_, const PubConfig& config_)
+  CPublisher::CPublisher(const std::string& topic_name_, const Publisher::Configuration& config_)
     : CPublisher(topic_name_, SDataTypeInformation{}, config_)
   {}
 
@@ -90,7 +90,7 @@ namespace eCAL
     return *this;
   }
 
-  bool CPublisher::Create(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubConfig& config_)
+  bool CPublisher::Create(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const Publisher::Configuration& config_)
   {
     if (m_created)              return(false);
     if (topic_name_.empty())    return(false);

diff --git a/ecal/core/src/pubsub/ecal_publisher_config.cpp b/ecal/core/src/pubsub/ecal_publisher_config.cpp
@@ -26,24 +26,27 @@
 
 namespace eCAL
 {
-  PubConfig::PubConfig() :
-    share_topic_type(eCAL::Config::IsTopicTypeSharingEnabled()),
-    share_topic_description(eCAL::Config::IsTopicDescriptionSharingEnabled())
+  namespace Publisher
   {
-    // shm config
-    shm.send_mode               = eCAL::Config::GetPublisherShmMode();
-    shm.zero_copy_mode          = eCAL::Config::IsMemfileZerocopyEnabled();
-    shm.acknowledge_timeout_ms  = eCAL::Config::GetMemfileAckTimeoutMs();
+    Configuration::Configuration() :
+      share_topic_type(eCAL::Config::IsTopicTypeSharingEnabled()),
+      share_topic_description(eCAL::Config::IsTopicDescriptionSharingEnabled())
+    {
+      // shm config
+      shm.send_mode               = eCAL::Config::GetPublisherShmMode();
+      shm.zero_copy_mode          = eCAL::Config::IsMemfileZerocopyEnabled();
+      shm.acknowledge_timeout_ms  = eCAL::Config::GetMemfileAckTimeoutMs();
 
-    shm.memfile_min_size_bytes  = eCAL::Config::GetMemfileMinsizeBytes();
-    shm.memfile_reserve_percent = eCAL::Config::GetMemfileOverprovisioningPercentage();
-    shm.memfile_buffer_count    = eCAL::Config::GetMemfileBufferCount();
+      shm.memfile_min_size_bytes  = eCAL::Config::GetMemfileMinsizeBytes();
+      shm.memfile_reserve_percent = eCAL::Config::GetMemfileOverprovisioningPercentage();
+      shm.memfile_buffer_count    = eCAL::Config::GetMemfileBufferCount();
 
-    // udp config
-    udp.send_mode               = eCAL::Config::GetPublisherUdpMulticastMode();
-    udp.sndbuf_size_bytes       = eCAL::Config::GetUdpMulticastSndBufSizeBytes();
+      // udp config
+      udp.send_mode               = eCAL::Config::GetPublisherUdpMulticastMode();
+      udp.sndbuf_size_bytes       = eCAL::Config::GetUdpMulticastSndBufSizeBytes();
 
-    // tcp config
-    tcp.send_mode               = eCAL::Config::GetPublisherTcpMode();
+      // tcp config
+      tcp.send_mode               = eCAL::Config::GetPublisherTcpMode();
+    }
   }
 }
diff --git a/ecal/core/src/readwrite/ecal_writer.cpp b/ecal/core/src/readwrite/ecal_writer.cpp
@@ -67,7 +67,7 @@ namespace std
 
 namespace eCAL
 {
-  CDataWriter::CDataWriter(const std::string& topic_name_, const SDataTypeInformation& topic_info_, const PubConfig& config_) :
+  CDataWriter::CDataWriter(const std::string& topic_name_, const SDataTypeInformation& topic_info_, const Publisher::Configuration& config_) :
     m_host_name(Process::GetHostName()),
     m_host_group_name(Process::GetHostGroupName()),
     m_pid(Process::GetProcessID()),

diff --git a/ecal/core/src/readwrite/ecal_writer.h b/ecal/core/src/readwrite/ecal_writer.h
@@ -85,7 +85,7 @@ namespace eCAL
       }
     };
 
-    CDataWriter(const std::string& topic_name_, const SDataTypeInformation& topic_info_, const PubConfig& config_ = {});
+    CDataWriter(const std::string& topic_name_, const SDataTypeInformation& topic_info_, const Publisher::Configuration& config_ = {});
     ~CDataWriter();
 
     bool SetDataTypeInformation(const SDataTypeInformation& topic_info_);
@@ -148,7 +148,7 @@ namespace eCAL
     SDataTypeInformation                   m_topic_info;
     std::map<std::string, std::string>     m_attr;
     size_t                                 m_topic_size;
-    PubConfig                              m_config;
+    Publisher::Configuration               m_config;
 
     std::vector<char>                      m_payload_buffer;
 

diff --git a/ecal/core/src/readwrite/shm/ecal_writer_shm.cpp b/ecal/core/src/readwrite/shm/ecal_writer_shm.cpp
@@ -32,7 +32,7 @@ namespace eCAL
 {
   const std::string CDataWriterSHM::m_memfile_base_name = "ecal_";
 
-  CDataWriterSHM::CDataWriterSHM(const std::string& /*host_name_*/, const std::string& topic_name_, const std::string& /*topic_id_*/, const SHMPubConfig& shm_config_) :
+  CDataWriterSHM::CDataWriterSHM(const std::string& /*host_name_*/, const std::string& topic_name_, const std::string& /*topic_id_*/, const Publisher::SHM::Configuration& shm_config_) :
     m_config(shm_config_)
   {
     m_topic_name = topic_name_;

diff --git a/ecal/core/src/readwrite/shm/ecal_writer_shm.h b/ecal/core/src/readwrite/shm/ecal_writer_shm.h
@@ -38,7 +38,7 @@ namespace eCAL
   class CDataWriterSHM : public CDataWriterBase
   {
   public:
-    CDataWriterSHM(const std::string& host_name_, const std::string& topic_name_, const std::string& topic_id_, const SHMPubConfig& shm_config_);
+    CDataWriterSHM(const std::string& host_name_, const std::string& topic_name_, const std::string& topic_id_, const Publisher::SHM::Configuration& shm_config_);
 
     SWriterInfo GetInfo() override;
 
@@ -53,7 +53,7 @@ namespace eCAL
     Registration::ConnectionPar GetConnectionParameter() override;
 
   protected:
-    SHMPubConfig                                  m_config;
+    Publisher::SHM::Configuration                 m_config;
 
     size_t                                        m_write_idx = 0;
     std::vector<std::shared_ptr<CSyncMemoryFile>> m_memory_file_vec;

diff --git a/ecal/core/src/readwrite/tcp/ecal_writer_tcp.cpp b/ecal/core/src/readwrite/tcp/ecal_writer_tcp.cpp
@@ -38,7 +38,7 @@ namespace eCAL
   std::mutex                            CDataWriterTCP::g_tcp_writer_executor_mtx;
   std::shared_ptr<tcp_pubsub::Executor> CDataWriterTCP::g_tcp_writer_executor;
 
-  CDataWriterTCP::CDataWriterTCP(const std::string& host_name_, const std::string& topic_name_, const std::string& topic_id_, const TCPPubConfig& tcp_config_) :
+  CDataWriterTCP::CDataWriterTCP(const std::string& host_name_, const std::string& topic_name_, const std::string& topic_id_, const Publisher::TCP::Configuration& tcp_config_) :
     m_config(tcp_config_)
   {
     {

diff --git a/ecal/core/src/readwrite/tcp/ecal_writer_tcp.h b/ecal/core/src/readwrite/tcp/ecal_writer_tcp.h
@@ -40,7 +40,7 @@ namespace eCAL
   class CDataWriterTCP : public CDataWriterBase
   {
   public:
-    CDataWriterTCP(const std::string& host_name_, const std::string& topic_name_, const std::string& topic_id_, const TCPPubConfig& tcp_config_);
+    CDataWriterTCP(const std::string& host_name_, const std::string& topic_name_, const std::string& topic_id_, const Publisher::TCP::Configuration& tcp_config_);
 
     SWriterInfo GetInfo() override;
 
@@ -49,7 +49,7 @@ namespace eCAL
     Registration::ConnectionPar GetConnectionParameter() override;
 
   private:
-    TCPPubConfig                                 m_config;
+    Publisher::TCP::Configuration                m_config;
 
     std::vector<char>                            m_header_buffer;
 

diff --git a/ecal/core/src/readwrite/udp/ecal_writer_udp.cpp b/ecal/core/src/readwrite/udp/ecal_writer_udp.cpp
@@ -31,7 +31,7 @@
 
 namespace eCAL
 {
-  CDataWriterUdpMC::CDataWriterUdpMC(const std::string& host_name_, const std::string& topic_name_, const std::string& topic_id_, const UDPPubConfig& udp_config_) :
+  CDataWriterUdpMC::CDataWriterUdpMC(const std::string& host_name_, const std::string& topic_name_, const std::string& topic_id_, const Publisher::UDP::Configuration& udp_config_) :
     m_config(udp_config_)
   {
     m_host_name   = host_name_;