eCAL core: provide TopicInformation (encoding, type, descriptor) instead of 2 strings (type, schema). #1126

KerstinKeller · 2023-06-14T13:54:40Z

eCAL core: provide TopicInformation (encoding, type, descriptor) instead of 2 strings (type, schema).

This commit contains various API changes, however made in a semver compliant way.

Adds various API functions and deprecates old ones
Adds field to topic.proto file
For communication compatibility, descriptor information is send out on old and new fields in proto message

Occurrences of deprecated functions fixed in eCAL Code (Samples, Apps, Tests)
Try to continue make builds.

Feature

Technically, this API should introduce no API breaks, only internal ones.

…ead of 2 strings (type, schema). This commit contains various API changes, however made in a semver compliant way. - Adds various API functions and deprecates old ones - Adds field to topic.proto file - For communication compatibility, descriptor information is send out on old and new fields in proto message Occurrences of deprecated functions fixed in eCAL Code (Samples, Apps, Tests) Try to continue make builds.

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 20 out of 25. Check the log or trigger a new build to see more.

app/mon/mon_gui/src/widgets/ecalmon_tree_widget/topic_widget.cpp

github-actions · 2023-06-14T14:17:24Z

ecal/core/include/ecal/msg/capnproto/dynamic.h

@@ -118,7 +118,9 @@ namespace eCAL
      {
        if (!initialized)
        {
-          std::string topic_desc = eCAL::Util::GetDescription(topic_name_);
+          STopicInformation topic_info_;


warning: uninitialized record type: 'topic_info_' [cppcoreguidelines-pro-type-member-init]

Suggested change

STopicInformation topic_info_;

STopicInformation topic_info_{};

github-actions · 2023-06-14T14:17:24Z

ecal/core/include/ecal/msg/capnproto/dynamic.h

      **/
-      std::string GetTypeName() const
+      STopicInformation GetTopicInformation() const


warning: method 'GetTopicInformation' can be made static [readability-convert-member-functions-to-static]

Suggested change

STopicInformation GetTopicInformation() const

static STopicInformation GetTopicInformation()

github-actions · 2023-06-14T14:17:25Z

ecal/core/include/ecal/msg/capnproto/dynamic.h

      {
-        return ("");
+        STopicInformation topic_info;


warning: uninitialized record type: 'topic_info' [cppcoreguidelines-pro-type-member-init]

Suggested change

STopicInformation topic_info;

STopicInformation topic_info{};

github-actions · 2023-06-14T14:17:25Z

ecal/core/include/ecal/msg/capnproto/publisher.h

      {
-        return eCAL::capnproto::TypeAsString<message_type>();
+        STopicInformation topic_info;


warning: variable 'topic_info' is not initialized [cppcoreguidelines-init-variables]

Suggested change

STopicInformation topic_info;

STopicInformation topic_info = 0;

github-actions · 2023-06-14T14:17:28Z

ecal/core/include/ecal/msg/publisher.h

+    [[deprecated("Please use STopicInformation GetTopicInformation() instead. This function will be removed in eCAL6.")]]
+    virtual std::string GetTypeName() const
+    {
+      STopicInformation topic_info{ GetTopicInformation() };


warning: variable 'topic_info' is not initialized [cppcoreguidelines-init-variables]

Suggested change

STopicInformation topic_info{ GetTopicInformation() };

STopicInformation topic_info = 0{ GetTopicInformation() };

github-actions · 2023-06-14T14:17:28Z

ecal/core/include/ecal/msg/string/publisher.h

@@ -58,7 +58,7 @@ namespace eCAL

      // call the function via its class becase it's a virtual function that is called in constructor/destructor,-
      // where the vtable is not created yet or it's destructed.
-      CPublisher(const std::string& topic_name_) : CMsgPublisher<T>(topic_name_, CPublisher::GetTypeName(), CPublisher::GetDescription())
+      CPublisher(const std::string& topic_name_) : CMsgPublisher<T>(topic_name_, GetTopicInformation())


warning: Call to virtual method 'CPublisher::GetTopicInformation' during construction bypasses virtual dispatch [clang-analyzer-optin.cplusplus.VirtualCall]

CPublisher(const std::string& topic_name_) : CMsgPublisher<T>(topic_name_, GetTopicInformation()) ^

Additional context

app/mon/mon_cli/src/ecal_mon_cli.cpp:551: Calling constructor for 'CPublisher<std::basic_string>'

eCAL::string::CPublisher<std::string> pub(topic_name); ^

ecal/core/include/ecal/msg/string/publisher.h:60: Call to virtual method 'CPublisher::GetTopicInformation' during construction bypasses virtual dispatch

CPublisher(const std::string& topic_name_) : CMsgPublisher<T>(topic_name_, GetTopicInformation()) ^

github-actions · 2023-06-14T14:17:29Z

ecal/core/include/ecal/msg/string/publisher.h

      {
-        return("");
+        STopicInformation topic_info;


warning: variable 'topic_info' is not initialized [cppcoreguidelines-init-variables]

Suggested change

STopicInformation topic_info;

STopicInformation topic_info = 0;

github-actions · 2023-06-14T14:17:29Z

ecal/core/include/ecal/msg/string/subscriber.h

      {
-        return("");
+        STopicInformation topic_info;


warning: variable 'topic_info' is not initialized [cppcoreguidelines-init-variables]

Suggested change

STopicInformation topic_info;

STopicInformation topic_info = 0;

github-actions · 2023-06-14T14:17:29Z

ecal/core/include/ecal/msg/subscriber.h

@@ -24,8 +24,8 @@

 #pragma once

-#include <ecal/ecal_publisher.h>
 #include <ecal/ecal_subscriber.h>


warning: 'ecal/ecal_subscriber.h' file not found [clang-diagnostic-error]

#include <ecal/ecal_subscriber.h> ^

app/mon/mon_cli/src/ecal_mon_cli.cpp

KerstinKeller · 2023-06-15T11:22:00Z

ecal/core/include/ecal/cimpl/ecal_callback_cimpl.h

+  const char*                tid;       //!< topic id of the connected subscriber                     (for pub_event_update_connection only)
+  const char*                ttype;     //!< topic type information of the connected subscriber       (for pub_event_update_connection only)
+  const char*                tdesc;     //!< topic descriptor information of the connected subscriber (for pub_event_update_connection only)
+  struct STopicInformationC  tinfo;     //!< topic information of the connected subscriber            (for pub_event_update_connection only)
 };


Take out until we fix C API completely (not with this PR)

ecal/core/include/ecal/ecal_util.h

ecal/core/include/ecal/types/ecal_topic_information.h

KerstinKeller · 2023-06-15T11:57:43Z

ecal/core/include/ecal/types/ecal_topic_information.h

+{
+    /**
+     * @brief eCAL transport layer types.
+    **/


Topic Information -> not transport layer types

ecal/core/src/ecal_clang.cpp

ecal/core/src/ecalc.cpp

KerstinKeller · 2023-06-15T12:10:01Z

ecal/core/src/mon/ecal_monitoring_impl.cpp

@@ -959,9 +961,6 @@ namespace eCAL
      // direction
      pMonTopic->set_direction(direction_);

-      // topic type
-      pMonTopic->set_ttype(topic.second.ttype);
-
      // topic transport layers


remove only with eCAL6!

KerstinKeller · 2023-06-15T12:12:33Z

ecal/core/src/pubsub/ecal_publisher.cpp

+    if (m_tlayer.sm_udp_mc == TLayer::smode_none) m_tlayer.sm_udp_mc = Config::GetPublisherUdpMulticastMode();
+    if (m_tlayer.sm_shm == TLayer::smode_none) m_tlayer.sm_shm = Config::GetPublisherShmMode();
+    if (m_tlayer.sm_tcp == TLayer::smode_none) m_tlayer.sm_tcp = Config::GetPublisherTcpMode();
+    if (m_tlayer.sm_inproc == TLayer::smode_none) m_tlayer.sm_inproc = Config::GetPublisherInprocMode();



Fix alignment

KerstinKeller · 2023-06-15T12:13:00Z

ecal/core/src/pubsub/ecal_publisher.cpp

+    m_datawriter->SetLayerMode(TLayer::tlayer_udp_mc, m_tlayer.sm_udp_mc);
+    m_datawriter->SetLayerMode(TLayer::tlayer_shm, m_tlayer.sm_shm);
+    m_datawriter->SetLayerMode(TLayer::tlayer_tcp, m_tlayer.sm_tcp);
+    m_datawriter->SetLayerMode(TLayer::tlayer_inproc, m_tlayer.sm_inproc);
    // create it


github-actions

clang-tidy made some suggestions

github-actions · 2023-06-15T13:42:07Z

ecal/core/include/ecal/msg/subscriber.h

+    [[deprecated("Please use STopicInformation GetTopicInformation() instead. This function will be removed in eCAL6.")]]
+    virtual std::string GetTypeName() const
+    {
+      STopicInformation topic_info{ GetTopicInformation() };


warning: variable 'topic_info' is not initialized [cppcoreguidelines-init-variables]

Suggested change

STopicInformation topic_info{ GetTopicInformation() };

STopicInformation topic_info = 0{ GetTopicInformation() };

github-actions · 2023-06-15T13:42:07Z

ecal/core/src/pubsub/ecal_pubgate.cpp

@@ -221,19 +220,19 @@ namespace eCAL
    }
  }

-  bool CPubGate::ApplyTopicToDescGate(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_)
+  bool CPubGate::ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_)


warning: method 'ApplyTopicToDescGate' can be made static [readability-convert-member-functions-to-static]

ecal/core/src/pubsub/ecal_pubgate.h:62:

- bool ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_); + static bool ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_);

github-actions · 2023-06-15T13:42:07Z

ecal/core/src/pubsub/ecal_publisher.cpp

@@ -420,21 +451,21 @@ namespace eCAL
    m_tlayer = TLayer::STLayer();
  }

-  bool CPublisher::ApplyTopicToDescGate(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_)
+  bool CPublisher::ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_)


warning: method 'ApplyTopicToDescGate' can be made static [readability-convert-member-functions-to-static]

ecal/core/include/ecal/ecal_publisher.h:537:

- bool ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_); + static bool ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_);

github-actions · 2023-06-15T13:42:08Z

ecal/core/src/pubsub/ecal_subgate.cpp

@@ -365,20 +364,20 @@ namespace eCAL
    return(0);
  }

-  bool CSubGate::ApplyTopicToDescGate(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_)
+  bool CSubGate::ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_)


warning: method 'ApplyTopicToDescGate' can be made static [readability-convert-member-functions-to-static]

ecal/core/src/pubsub/ecal_subgate.h:62:

- bool ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_); + static bool ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_);

github-actions · 2023-06-15T13:42:08Z

ecal/core/src/pubsub/ecal_subscriber.cpp

@@ -269,20 +292,20 @@ namespace eCAL
    m_qos.reliability = QOS::best_effort_reliability_qos;
  }

-  bool CSubscriber::ApplyTopicToDescGate(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_)
+  bool CSubscriber::ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_)


warning: method 'ApplyTopicToDescGate' can be made static [readability-convert-member-functions-to-static]

ecal/core/include/ecal/ecal_subscriber.h:348:

- bool ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_); + static bool ApplyTopicToDescGate(const std::string& topic_name_, const STopicInformation& topic_info_);

KerstinKeller added 2 commits June 14, 2023 14:24

Keep build going.

9fbcba4

github-actions bot reviewed Jun 14, 2023

View reviewed changes

FlorianReimold added this to the eCAL 5.12 milestone Jun 15, 2023

KerstinKeller changed the title ~~Feature/topic type encoding split 3~~ eCAL core: provide TopicInformation (encoding, type, descriptor) instead of 2 strings (type, schema). Jun 15, 2023