Feature event naming #1898

KerstinKeller · 2025-01-14T14:57:28Z

Description

All v6 callbacks / events have ID removed from their names.

github-actions

clang-tidy made some suggestions

github-actions · 2025-01-14T15:11:19Z

ecal/core/src/pubsub/ecal_publisher.cpp

@@ -47,11 +47,11 @@ namespace eCAL
    if(g_pubgate() != nullptr) g_pubgate()->Register(topic_name_, m_publisher_impl);
  }

-  CPublisher::CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubEventIDCallbackT event_callback_, const Publisher::Configuration& config_) :
+  CPublisher::CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubEventCallbackT event_callback_, const Publisher::Configuration& config_) :


warning: the const qualified parameter 'event_callback_' is copied for each invocation; consider making it a reference [performance-unnecessary-value-param]

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

- CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubEventCallbackT event_callback_, const Publisher::Configuration& config_ = GetPublisherConfiguration()); + CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubEventCallbackT& event_callback_, const Publisher::Configuration& config_ = GetPublisherConfiguration());

Suggested change

CPublisher::CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubEventCallbackT event_callback_, const Publisher::Configuration& config_) :

CPublisher::CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubEventCallbackT& event_callback_, const Publisher::Configuration& config_) :

github-actions · 2025-01-14T15:11:20Z

ecal/core/src/pubsub/ecal_publisher_impl.cpp

@@ -400,12 +400,12 @@ namespace eCAL
    return(true);
  }

-  bool CPublisherImpl::SetEventIDCallback(const PubEventIDCallbackT callback_)
+  bool CPublisherImpl::SetEventCallback(const PubEventCallbackT callback_)


warning: the const qualified parameter 'callback_' is copied for each invocation; consider making it a reference [performance-unnecessary-value-param]

ecal/core/src/pubsub/ecal_publisher_impl.h:89:

- bool SetEventCallback(const PubEventCallbackT callback_); + bool SetEventCallback(const PubEventCallbackT& callback_);

Suggested change

bool CPublisherImpl::SetEventCallback(const PubEventCallbackT callback_)

bool CPublisherImpl::SetEventCallback(const PubEventCallbackT& callback_)

github-actions · 2025-01-14T15:11:20Z

ecal/core/src/pubsub/ecal_subscriber.cpp

@@ -40,7 +40,7 @@ namespace eCAL
    if (g_subgate() != nullptr) g_subgate()->Register(topic_name_, m_subscriber_impl);
  }

-  CSubscriber::CSubscriber(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const SubEventIDCallbackT event_callback_, const Subscriber::Configuration& config_) :
+  CSubscriber::CSubscriber(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const SubEventCallbackT event_callback_, const Subscriber::Configuration& config_) :


warning: the const qualified parameter 'event_callback_' is copied for each invocation; consider making it a reference [performance-unnecessary-value-param]

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

- CSubscriber(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const SubEventCallbackT event_callback_, const Subscriber::Configuration& config_ = GetSubscriberConfiguration()); + CSubscriber(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const SubEventCallbackT& event_callback_, const Subscriber::Configuration& config_ = GetSubscriberConfiguration());

Suggested change

CSubscriber::CSubscriber(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const SubEventCallbackT event_callback_, const Subscriber::Configuration& config_) :

CSubscriber::CSubscriber(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const SubEventCallbackT& event_callback_, const Subscriber::Configuration& config_) :

github-actions · 2025-01-14T15:11:20Z

ecal/core/src/pubsub/ecal_subscriber_impl.cpp

@@ -231,7 +231,7 @@ namespace eCAL
    return(true);
  }

-  bool CSubscriberImpl::SetEventIDCallback(const SubEventIDCallbackT callback_)
+  bool CSubscriberImpl::SetEventIDCallback(const SubEventCallbackT callback_)


warning: the const qualified parameter 'callback_' is copied for each invocation; consider making it a reference [performance-unnecessary-value-param]

Suggested change

bool CSubscriberImpl::SetEventIDCallback(const SubEventCallbackT callback_)

bool CSubscriberImpl::SetEventIDCallback(const SubEventCallbackT& callback_)

ecal/core/src/pubsub/ecal_subscriber_impl.h:80:

- bool SetEventIDCallback(const SubEventCallbackT callback_); + bool SetEventIDCallback(const SubEventCallbackT& callback_);

github-actions · 2025-01-14T15:11:20Z

ecal/core/src/service/ecal_service_client.cpp

@@ -31,7 +31,7 @@

 namespace eCAL
 {
-  CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_, const ClientEventIDCallbackT event_callback_)
+  CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_, const ClientEventCallbackT event_callback_)


warning: the const qualified parameter 'event_callback_' is copied for each invocation; consider making it a reference [performance-unnecessary-value-param]

ecal/core/include/ecal/ecal_client.h:58:

- CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_ = ServiceMethodInformationMapT(), const ClientEventCallbackT event_callback_ = ClientEventCallbackT()); + CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_ = ServiceMethodInformationMapT(), const ClientEventCallbackT& event_callback_ = ClientEventCallbackT());

Suggested change

CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_, const ClientEventCallbackT event_callback_)

CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_, const ClientEventCallbackT& event_callback_)

github-actions · 2025-01-14T15:11:20Z

ecal/core/src/service/ecal_service_client.cpp

@@ -31,7 +31,7 @@

 namespace eCAL
 {
-  CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_, const ClientEventIDCallbackT event_callback_)
+  CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_, const ClientEventCallbackT event_callback_)


warning: the const qualified parameter 'method_information_map_' is copied for each invocation; consider making it a reference [performance-unnecessary-value-param]

ecal/core/include/ecal/ecal_client.h:58:

- CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_ = ServiceMethodInformationMapT(), const ClientEventCallbackT event_callback_ = ClientEventCallbackT()); + CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT& method_information_map_ = ServiceMethodInformationMapT(), const ClientEventCallbackT event_callback_ = ClientEventCallbackT());

Suggested change

CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_, const ClientEventCallbackT event_callback_)

CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT& method_information_map_, const ClientEventCallbackT event_callback_)

github-actions · 2025-01-14T15:11:21Z

ecal/core/src/service/ecal_service_client_v5_impl.cpp

@@ -94,7 +94,7 @@ namespace eCAL
      Logging::Log(log_level_debug1, "v5::CServiceClientImpl: Creating service client with name: " + service_name_);

      // Define the event callback to pass to CServiceClient
-      ClientEventIDCallbackT event_callback = [this](const Registration::SServiceMethodId& service_id_, const struct SClientEventIDCallbackData& data_)
+      v6::ClientEventCallbackT event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SClientEventCallbackData& data_)


warning: variable 'event_callback' of type 'v6::ClientEventCallbackT' (aka 'function<void (const Registration::SServiceMethodId &, const SClientEventCallbackData &)>') can be declared 'const' [misc-const-correctness]

Suggested change

v6::ClientEventCallbackT event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SClientEventCallbackData& data_)

v6::ClientEventCallbackT const event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SClientEventCallbackData& data_)

github-actions · 2025-01-14T15:11:21Z

ecal/core/src/service/ecal_service_server.cpp

@@ -29,7 +29,7 @@

 namespace eCAL
 {
-  CServiceServer::CServiceServer(const std::string& service_name_, const ServerEventIDCallbackT event_callback_)
+  CServiceServer::CServiceServer(const std::string& service_name_, const ServerEventCallbackT event_callback_)


warning: the const qualified parameter 'event_callback_' is copied for each invocation; consider making it a reference [performance-unnecessary-value-param]

Suggested change

CServiceServer::CServiceServer(const std::string& service_name_, const ServerEventCallbackT event_callback_)

CServiceServer::CServiceServer(const std::string& service_name_, const ServerEventCallbackT& event_callback_)

ecal/core/include/ecal/ecal_server.h:55:

- explicit CServiceServer(const std::string& service_name_, const ServerEventCallbackT event_callback_ = ServerEventCallbackT()); + explicit CServiceServer(const std::string& service_name_, const ServerEventCallbackT& event_callback_ = ServerEventCallbackT());

github-actions · 2025-01-14T15:11:21Z

ecal/core/src/service/ecal_service_server_impl.cpp

@@ -49,7 +49,7 @@ namespace eCAL
  }

  // Constructor
-  CServiceServerImpl::CServiceServerImpl(const std::string& service_name_, const ServerEventIDCallbackT& event_callback_)
+  CServiceServerImpl::CServiceServerImpl(const std::string& service_name_, const ServerEventCallbackT& event_callback_)


warning: constructor does not initialize these fields: m_service_id [cppcoreguidelines-pro-type-member-init]

ecal/core/src/service/ecal_service_server_impl.h:100:

- Registration::EntityIdT m_service_id; + Registration::EntityIdT m_service_id{};

github-actions · 2025-01-14T15:11:21Z

ecal/core/src/service/ecal_service_server_v5_impl.cpp

@@ -57,7 +57,7 @@ namespace eCAL
      }

      // Define the event callback to pass to CServiceClient
-      ServerEventIDCallbackT event_callback = [this](const Registration::SServiceMethodId& service_id_, const struct SServerEventIDCallbackData& data_)
+      v6::ServerEventCallbackT event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SServerEventCallbackData& data_)


warning: variable 'event_callback' of type 'v6::ServerEventCallbackT' (aka 'function<void (const Registration::SServiceMethodId &, const struct SServerEventCallbackData &)>') can be declared 'const' [misc-const-correctness]

Suggested change

v6::ServerEventCallbackT event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SServerEventCallbackData& data_)

v6::ServerEventCallbackT const event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SServerEventCallbackData& data_)

Peguen

✍️

KerstinKeller added 2 commits January 14, 2025 14:58

[core] Remove "ID" naming from all callbacks / events.

6b9ca5b

[core] remove "ID" naming part from all callback types in V6.

4f81398

KerstinKeller added the cherry-pick-to-NONE Don't cherry-pick these changes label Jan 14, 2025

KerstinKeller requested review from rex-schilasky and Peguen January 14, 2025 14:57

github-actions bot reviewed Jan 14, 2025

View reviewed changes

Peguen approved these changes Jan 14, 2025

View reviewed changes

KerstinKeller merged commit 5a90554 into master Jan 14, 2025
22 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature event naming #1898

Feature event naming #1898

KerstinKeller commented Jan 14, 2025

github-actions bot left a comment

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

Peguen left a comment

	CPublisher::CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubEventCallbackT event_callback_, const Publisher::Configuration& config_) :
	CPublisher::CPublisher(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const PubEventCallbackT& event_callback_, const Publisher::Configuration& config_) :

	bool CPublisherImpl::SetEventCallback(const PubEventCallbackT callback_)
	bool CPublisherImpl::SetEventCallback(const PubEventCallbackT& callback_)

	CSubscriber::CSubscriber(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const SubEventCallbackT event_callback_, const Subscriber::Configuration& config_) :
	CSubscriber::CSubscriber(const std::string& topic_name_, const SDataTypeInformation& data_type_info_, const SubEventCallbackT& event_callback_, const Subscriber::Configuration& config_) :

	bool CSubscriberImpl::SetEventIDCallback(const SubEventCallbackT callback_)
	bool CSubscriberImpl::SetEventIDCallback(const SubEventCallbackT& callback_)

	CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_, const ClientEventCallbackT event_callback_)
	CServiceClient::CServiceClient(const std::string& service_name_, const ServiceMethodInformationMapT method_information_map_, const ClientEventCallbackT& event_callback_)

	v6::ClientEventCallbackT event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SClientEventCallbackData& data_)
	v6::ClientEventCallbackT const event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SClientEventCallbackData& data_)

	CServiceServer::CServiceServer(const std::string& service_name_, const ServerEventCallbackT event_callback_)
	CServiceServer::CServiceServer(const std::string& service_name_, const ServerEventCallbackT& event_callback_)

	v6::ServerEventCallbackT event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SServerEventCallbackData& data_)
	v6::ServerEventCallbackT const event_callback = [this](const Registration::SServiceMethodId& service_id_, const v6::SServerEventCallbackData& data_)

Feature event naming #1898

Feature event naming #1898

Conversation

KerstinKeller commented Jan 14, 2025

Description

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

Peguen left a comment

Choose a reason for hiding this comment