[core] redesign service server api #1849

rex-schilasky · 2024-12-09T19:12:22Z

Description

Implement a new service server API (symmetrically to new service client API).

m_created removed

github-actions

clang-tidy made some suggestions

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

github-actions · 2024-12-09T19:26:10Z

ecal/core/include/ecal/ecal_server.h

     *
     * @param service_name_   Unique service name.
    **/
    ECAL_API_EXPORTED_MEMBER
-      explicit CServiceServer(const std::string& service_name_);
+      explicit CServiceServer(const std::string& service_name_, const ServerEventIDCallbackT event_callback_ = ServerEventIDCallbackT());


warning: parameter 'event_callback_' is const-qualified in the function declaration; const-qualification of parameters only has an effect in function definitions [readability-avoid-const-params-in-decls]

Suggested change

explicit CServiceServer(const std::string& service_name_, const ServerEventIDCallbackT event_callback_ = ServerEventIDCallbackT());

explicit CServiceServer(const std::string& service_name_, ServerEventIDCallbackT event_callback_ = ServerEventIDCallbackT());

github-actions · 2024-12-09T19:26:10Z

ecal/core/include/ecal/ecal_server.h

@@ -116,7 +76,7 @@
     * @return  True if successful.
    **/
    ECAL_API_EXPORTED_MEMBER
-      bool AddMethodCallback(const std::string& method_, const std::string& req_type_, const std::string& resp_type_, const MethodCallbackT& callback_);
+      bool AddMethodCallback(const std::string& method_, const SServiceMethodInformation& method_info_, const MethodCallbackT& callback_);


warning: no header providing "eCAL::SServiceMethodInformation" is directly included [misc-include-cleaner]

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

- #include <ecal/ecal_deprecate.h> + #include "ecal/ecal_types.h" + #include <ecal/ecal_deprecate.h>

github-actions · 2024-12-09T19:26:10Z

ecal/core/include/ecal/ecal_server_v5.h

+#pragma once
+
+#include <ecal/ecal_deprecate.h>
+#include <ecal/ecal_os.h>


warning: included header ecal_deprecate.h is not used directly [misc-include-cleaner]

Suggested change

#include <ecal/ecal_os.h>

#include <ecal/ecal_os.h>

github-actions · 2024-12-09T19:26:11Z

ecal/core/include/ecal/ecal_server_v5.h

+
+#include <string>
+#include <vector>
+#include <memory>


warning: included header vector is not used directly [misc-include-cleaner]

Suggested change

#include <memory>

#include <memory>

github-actions · 2024-12-09T19:26:11Z

ecal/core/include/ecal/ecal_server_v5.h

+    /**
+     * @brief Service Server wrapper class.
+    **/
+    class ECAL_API_CLASS CServiceServer


warning: class 'CServiceServer' defines a destructor, a copy constructor and a copy assignment operator but does not define a move constructor or a move assignment operator [cppcoreguidelines-special-member-functions]

class ECAL_API_CLASS CServiceServer ^

github-actions · 2024-12-09T19:26:12Z

ecal/core/src/service/ecal_service_server_impl.cpp

-
-  std::shared_ptr<CServiceServerImpl> CServiceServerImpl::CreateInstance(const std::string& service_name_)
+  // Factory method to create a new instance of CServiceClientImpl
+  std::shared_ptr<CServiceServerImpl> CServiceServerImpl::CreateInstance(


warning: no header providing "std::shared_ptr" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:27:

+ #include <memory>

github-actions · 2024-12-09T19:26:12Z

ecal/core/src/service/ecal_service_server_impl.cpp

-  std::shared_ptr<CServiceServerImpl> CServiceServerImpl::CreateInstance(const std::string& service_name_)
+  // Factory method to create a new instance of CServiceClientImpl
+  std::shared_ptr<CServiceServerImpl> CServiceServerImpl::CreateInstance(
+    const std::string& service_name_, const ServerEventIDCallbackT& event_callback_)


warning: no header providing "eCAL::ServerEventIDCallbackT" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:23:

- #include "ecal_global_accessors.h" + #include "ecal/ecal_callback.h" + #include "ecal_global_accessors.h"

github-actions · 2024-12-09T19:26:12Z

ecal/core/src/service/ecal_service_server_impl.cpp

-  std::shared_ptr<CServiceServerImpl> CServiceServerImpl::CreateInstance(const std::string& service_name_)
+  // Factory method to create a new instance of CServiceClientImpl
+  std::shared_ptr<CServiceServerImpl> CServiceServerImpl::CreateInstance(
+    const std::string& service_name_, const ServerEventIDCallbackT& event_callback_)


warning: no header providing "std::string" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:27:

+ #include <string>

github-actions · 2024-12-09T19:26:12Z

ecal/core/src/service/ecal_service_server_impl.cpp

    {
-      const std::lock_guard<std::mutex> connected_lock(m_connected_mutex);
-      m_connected = false;
+      const std::lock_guard<std::mutex> lock(m_event_callback_mutex);


warning: no header providing "std::lock_guard" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:27:

+ #include <mutex>

github-actions · 2024-12-09T19:26:12Z

ecal/core/src/service/ecal_service_server_impl.cpp

    {
-      const std::lock_guard<std::mutex> connected_lock(m_connected_mutex);
-      m_connected = false;
+      const std::lock_guard<std::mutex> lock(m_event_callback_mutex);


warning: no header providing "std::mutex" is directly included [misc-include-cleaner]

const std::lock_guard<std::mutex> lock(m_event_callback_mutex); ^

service gate aligned with client gate service configuration removed

tests adapted

…ce-api

missing include

github-actions

clang-tidy made some suggestions

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

github-actions · 2024-12-11T12:50:31Z

ecal/core/include/ecal/ecal_server_v5.h

+#include <memory>
+#include <string>
+#include <vector>
+


warning: included header vector is not used directly [misc-include-cleaner]

Suggested change

github-actions · 2024-12-11T12:50:31Z

ecal/core/src/service/ecal_service_client_v5_impl.cpp

    {
+      Logging::Log(log_level_debug2, "v5::CServiceClientImpl: Initializing default service client implementation.");


warning: no header providing "log_level_debug2" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_client_v5_impl.cpp:24:

- #include <ecal/ecal_log.h> + #include "ecal/ecal_log_level.h" + #include <ecal/ecal_log.h>

github-actions · 2024-12-11T12:50:31Z

ecal/core/src/service/ecal_service_client_v5_impl.cpp

-      if (m_created) return false;
+      if (m_service_client_impl != nullptr)
+      {
+        Logging::Log(log_level_warning, "v5::CServiceClientImpl: Service client already created: " + service_name_);


warning: no header providing "log_level_warning" is directly included [misc-include-cleaner]

Logging::Log(log_level_warning, "v5::CServiceClientImpl: Service client already created: " + service_name_); ^

github-actions · 2024-12-11T12:50:31Z

ecal/core/src/service/ecal_service_client_v5_impl.cpp

+        return false;
+      }
+
+      Logging::Log(log_level_debug1, "v5::CServiceClientImpl: Creating service client with name: " + service_name_);


warning: no header providing "log_level_debug1" is directly included [misc-include-cleaner]

Logging::Log(log_level_debug1, "v5::CServiceClientImpl: Creating service client with name: " + service_name_); ^

github-actions · 2024-12-11T12:50:31Z

ecal/core/src/service/ecal_service_client_v5_impl.cpp

      ClientEventIDCallbackT event_callback = [this](const Registration::SServiceMethodId& service_id_, const struct SClientEventCallbackData& data_)
        {
+          Logging::Log(log_level_debug2, "v5::CServiceClientImpl: Event callback triggered for event type: " + std::to_string(data_.type));


warning: no header providing "std::to_string" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_client_v5_impl.cpp:25:

+ #include <string>

github-actions · 2024-12-11T12:50:32Z

ecal/core/src/service/ecal_service_server_impl.cpp

-  std::shared_ptr<CServiceServerImpl> CServiceServerImpl::CreateInstance(const std::string& service_name_)
+  // Factory method to create a new instance of CServiceServerImpl
+  std::shared_ptr<CServiceServerImpl> CServiceServerImpl::CreateInstance(
+    const std::string& service_name_, const ServerEventIDCallbackT& event_callback_)


warning: no header providing "std::string" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:26:

+ #include <string>

github-actions · 2024-12-11T12:50:33Z

ecal/core/src/service/ecal_service_server_impl.cpp

  {
-    auto instance = std::shared_ptr<CServiceServerImpl> (new CServiceServerImpl());
-    instance->Start(service_name_);
+    Logging::Log(log_level_debug1, "CServiceServerImpl::CreateInstance: Creating instance of CServiceServerImpl for service: " + service_name_);


warning: no header providing "log_level_debug1" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:27:

- #include "ecal_global_accessors.h" + #include "ecal/ecal_log_level.h" + #include "ecal_global_accessors.h"

github-actions · 2024-12-11T12:50:33Z

ecal/core/src/service/ecal_service_server_impl.cpp

    Stop();
  }

-  bool CServiceServerImpl::Start(const std::string& service_name_)
+  bool CServiceServerImpl::AddMethodCallback(const std::string& method_, const SServiceMethodInformation& method_info_, const MethodCallbackT& callback_)


warning: no header providing "eCAL::MethodCallbackT" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:27:

- #include "ecal_global_accessors.h" + #include "ecal/ecal_service_info.h" + #include "ecal_global_accessors.h"

github-actions · 2024-12-11T12:50:33Z

ecal/core/src/service/ecal_service_server_impl.cpp

    Stop();
  }

-  bool CServiceServerImpl::Start(const std::string& service_name_)
+  bool CServiceServerImpl::AddMethodCallback(const std::string& method_, const SServiceMethodInformation& method_info_, const MethodCallbackT& callback_)


warning: no header providing "eCAL::SServiceMethodInformation" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:27:

- #include "ecal_global_accessors.h" + #include "ecal/ecal_types.h" + #include "ecal_global_accessors.h"

github-actions · 2024-12-11T12:50:33Z

ecal/core/src/service/ecal_service_server_impl.cpp

-    // set service name
-    m_service_name = service_name_;
+    Logging::Log(log_level_debug1, "CServiceServerImpl: Adding method callback for method: " + method_);
+    std::lock_guard<std::mutex> const lock(m_method_map_mutex);


warning: no header providing "std::lock_guard" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:26:

+ #include <mutex>

…(not implemented yet)

Peguen

🛸 abgespaced

Peguen · 2024-12-12T11:09:35Z

ecal/core/src/service/ecal_service_client_v5_impl.cpp

            // Call the stored response callback
            m_response_callback(service_response_);
          }
        };

      // Call the method asynchronously using the new API
-      return m_service_client_impl->CallWithCallbackAsync(method_name_, request_, wrapped_callback);
+      bool success = m_service_client_impl->CallWithCallbackAsync(method_name_, request_, wrapped_callback);
+      Logging::Log(log_level_debug1, "v5::CServiceClientImpl: Async call to method: " + method_name_ + " completed with success: " + std::to_string(success));


success cast to "true" or "false" in future

Peguen · 2024-12-12T11:20:05Z

ecal/core/src/service/ecal_service_server.cpp

+      // Unregister server
+      if (g_servicegate() != nullptr)
+      {
+        //g_servicegate()->Unregister(m_service_server_impl->GetServiceName(), m_service_server_impl);


Please check this again

Peguen · 2024-12-12T11:23:03Z

ecal/core/src/service/ecal_service_server.cpp

+      // Move data
+      m_service_server_impl = std::move(rhs.m_service_server_impl);
+
+      rhs.m_service_server_impl = nullptr;


resetting is redundant, can be deleted

Peguen · 2024-12-12T11:30:06Z

ecal/core/src/service/ecal_service_server_impl.cpp

-    instance->Start(service_name_);
+    Logging::Log(log_level_debug1, "CServiceServerImpl::CreateInstance: Creating instance of CServiceServerImpl for service: " + service_name_);
+    auto instance = std::shared_ptr<CServiceServerImpl>(new CServiceServerImpl(service_name_, event_callback_));
+    instance->Start();


Check if instance was created.

Peguen · 2024-12-12T11:54:03Z

ecal/core/src/service/ecal_service_server_impl.cpp

+    // Stop TCP server
+    if (m_tcp_server)
+    {
+      m_tcp_server->stop();


Check to reset shared ptr

Peguen · 2024-12-13T15:56:02Z

ecal/samples/cpp/services/minimal_server/src/minimal_server.cpp

@@ -39,7 +40,7 @@ int main()
  eCAL::Initialize("minimal server");

  // create minimal service server
-  eCAL::CServiceServer minimal_server("service1");
+  eCAL::v5::CServiceServer minimal_server("service1");


Samples move to V6

Peguen · 2024-12-13T15:56:22Z

ecal/samples/cpp/services/latency_server/src/latency_server.cpp

@@ -34,7 +35,7 @@ int main()
  eCAL::Initialize("latency server");

  // create latency service
-  eCAL::CServiceServer latency_service("latency");
+  eCAL::v5::CServiceServer latency_service("latency");


github-actions

clang-tidy made some suggestions

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

github-actions · 2024-12-13T16:22:35Z

ecal/core/include/ecal/ecal_server.h

+       * @param event_callback_ Callback function for server events.
+      **/
+      ECAL_API_EXPORTED_MEMBER
+        explicit CServiceServer(const std::string& service_name_, const ServerEventIDCallbackT event_callback_ = ServerEventIDCallbackT());


warning: parameter 'event_callback_' is const-qualified in the function declaration; const-qualification of parameters only has an effect in function definitions [readability-avoid-const-params-in-decls]

Suggested change

explicit CServiceServer(const std::string& service_name_, const ServerEventIDCallbackT event_callback_ = ServerEventIDCallbackT());

explicit CServiceServer(const std::string& service_name_, ServerEventIDCallbackT event_callback_ = ServerEventIDCallbackT());

github-actions · 2024-12-13T16:22:35Z

ecal/core/src/service/ecal_service_client.cpp

    return m_service_client_impl->GetServiceName();
  }

+  Registration::SServiceMethodId CServiceClient::GetServiceId() const


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

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

- Registration::SServiceMethodId GetServiceId() const; + static Registration::SServiceMethodId GetServiceId() ;

Suggested change

Registration::SServiceMethodId CServiceClient::GetServiceId() const

Registration::SServiceMethodId CServiceClient::GetServiceId()

github-actions · 2024-12-13T16:22:35Z

ecal/core/src/service/ecal_service_client.cpp

    return m_service_client_impl->GetServiceName();
  }

+  Registration::SServiceMethodId CServiceClient::GetServiceId() const


warning: no header providing "eCAL::Registration::SServiceMethodId" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_client.cpp:25:

- #include "ecal_clientgate.h" + #include "ecal/ecal_types.h" + #include "ecal_clientgate.h"

github-actions · 2024-12-13T16:22:36Z

ecal/core/src/service/ecal_service_client_impl.cpp

@@ -103,6 +103,7 @@ namespace
  void ResponseError(const eCAL::Registration::SEntityId& entity_id_, const std::string& service_name_, const std::string& method_name_,
    const std::string& error_message_, const eCAL::ResponseIDCallbackT& response_callback_)
  {
+    eCAL::Logging::Log(log_level_error, "CServiceClientImpl: Response error for service: " + service_name_ + ", method: " + method_name_ + ", error: " + error_message_);


warning: no header providing "eCAL::Logging::Log" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_client_impl.cpp:23:

- #include "ecal_global_accessors.h" + #include "ecal/ecal_log.h" + #include "ecal_global_accessors.h"

github-actions · 2024-12-13T16:22:36Z

ecal/core/src/service/ecal_service_client_impl.cpp

@@ -103,6 +103,7 @@
  void ResponseError(const eCAL::Registration::SEntityId& entity_id_, const std::string& service_name_, const std::string& method_name_,
    const std::string& error_message_, const eCAL::ResponseIDCallbackT& response_callback_)
  {
+    eCAL::Logging::Log(log_level_error, "CServiceClientImpl: Response error for service: " + service_name_ + ", method: " + method_name_ + ", error: " + error_message_);


warning: no header providing "log_level_error" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_client_impl.cpp:23:

- #include "ecal_global_accessors.h" + #include "ecal/ecal_log_level.h" + #include "ecal_global_accessors.h"

github-actions · 2024-12-13T16:22:37Z

ecal/core/src/service/ecal_service_server_impl.cpp

-    std::string req_desc;
-    std::string resp_desc;
+    // Create service ID
+    std::stringstream counter;


warning: no header providing "std::stringstream" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:26:

+ #include <sstream>

github-actions · 2024-12-13T16:22:37Z

ecal/core/src/service/ecal_service_server_impl.cpp

-    std::string resp_desc;
+    // Create service ID
+    std::stringstream counter;
+    counter << std::chrono::steady_clock::now().time_since_epoch().count();


warning: no header providing "std::chrono::steady_clock" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:23:

- #include <ecal/ecal_config.h> + #include <chrono> + #include <ecal/ecal_config.h>

github-actions · 2024-12-13T16:22:37Z

ecal/core/src/service/ecal_service_server_impl.cpp

-        method.callback         = callback_;
-        m_method_map[method_] = method;
-      }
+      Logging::Log(log_level_error, "CServiceServerImpl: Failed to start service: Global server manager is unavailable or stopped for: " + m_service_name);


warning: no header providing "log_level_error" is directly included [misc-include-cleaner]

Logging::Log(log_level_error, "CServiceServerImpl: Failed to start service: Global server manager is unavailable or stopped for: " + m_service_name); ^

github-actions · 2024-12-13T16:22:37Z

ecal/core/src/service/ecal_service_server_impl.cpp

-    return true;
-  }
+    // Create callback functions
+    const eCAL::service::Server::EventCallbackT event_callback =


warning: no header providing "eCAL::service::Server" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:27:

- #include "ecal_global_accessors.h" + #include "ecal/service/server.h" + #include "ecal_global_accessors.h"

github-actions · 2024-12-13T16:22:37Z

ecal/core/src/service/ecal_service_server_impl.cpp

-  }
+    // Create callback functions
+    const eCAL::service::Server::EventCallbackT event_callback =
+      [weak_me = std::weak_ptr<CServiceServerImpl>(shared_from_this())](eCAL::service::ServerEventType event, const std::string& message)


warning: no header providing "eCAL::service::ServerEventType" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:27:

- #include "ecal_global_accessors.h" + #include "ecal/service/server_session_types.h" + #include "ecal_global_accessors.h"

minimal warning fix in CDataReader (lock name change) TODO's added for CServiceServer and CServiceClient

github-actions

clang-tidy made some suggestions

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

github-actions · 2024-12-13T17:23:47Z

ecal/core/src/readwrite/ecal_reader.cpp

@@ -534,7 +534,7 @@ namespace eCAL
        pub_info.process_id = topic_info_.pid;

        // execute it
-        std::lock_guard<std::mutex> lock(m_connection_map_mtx);
+        std::lock_guard<std::mutex> exec_lock(m_connection_map_mtx);


warning: variable 'exec_lock' of type 'std::lock_guardstd::mutex' can be declared 'const' [misc-const-correctness]

Suggested change

std::lock_guard<std::mutex> exec_lock(m_connection_map_mtx);

std::lock_guard<std::mutex> const exec_lock(m_connection_map_mtx);

github-actions · 2024-12-13T17:23:47Z

ecal/core/src/service/ecal_service_client.cpp

    return m_service_client_impl->GetServiceName();
  }

+  Registration::SServiceMethodId CServiceClient::GetServiceId() const


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

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

- Registration::SServiceMethodId GetServiceId() const; + static Registration::SServiceMethodId GetServiceId() ;

Suggested change

Registration::SServiceMethodId CServiceClient::GetServiceId() const

Registration::SServiceMethodId CServiceClient::GetServiceId()

github-actions · 2024-12-13T17:23:47Z

ecal/core/src/service/ecal_service_server.cpp

-   * @return  The service name.
-  **/
-  std::string CServiceServer::GetServiceName()
+  Registration::SServiceMethodId CServiceServer::GetServiceId() const


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

Suggested change

Registration::SServiceMethodId CServiceServer::GetServiceId() const

Registration::SServiceMethodId CServiceServer::GetServiceId()

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

- Registration::SServiceMethodId GetServiceId() const; + static Registration::SServiceMethodId GetServiceId() ;

github-actions · 2024-12-13T17:23:47Z

ecal/core/src/service/ecal_service_server_impl.cpp

+#ifndef NDEBUG
+    Logging::Log(log_level_debug1, "CServiceServerImpl::AddMethodCallback: Adding method callback for method: " + method_);
+#endif
+    const std::lock_guard<std::mutex> lock(m_method_map_mutex);


warning: no header providing "std::lock_guard" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_impl.cpp:26:

+ #include <mutex>

github-actions · 2024-12-13T17:23:48Z

ecal/core/src/service/ecal_service_server_impl.cpp

+#ifndef NDEBUG
+    Logging::Log(log_level_debug1, "CServiceServerImpl::AddMethodCallback: Adding method callback for method: " + method_);
+#endif
+    const std::lock_guard<std::mutex> lock(m_method_map_mutex);


warning: no header providing "std::mutex" is directly included [misc-include-cleaner]

const std::lock_guard<std::mutex> lock(m_method_map_mutex); ^

github-actions · 2024-12-13T17:23:49Z

ecal/core/src/service/ecal_service_server_impl.h

    int RequestCallback(const std::string& request_pb_, std::string& response_pb_);
-    void EventCallback(eCAL_Server_Event event_, const std::string& message_);
+    void NotifyEventCallback(const Registration::SServiceMethodId& service_id_, eCAL_Server_Event event_type_, const std::string& message_);


warning: no header providing "eCAL::Registration::SServiceMethodId" is directly included [misc-include-cleaner]

void NotifyEventCallback(const Registration::SServiceMethodId& service_id_, eCAL_Server_Event event_type_, const std::string& message_); ^

github-actions · 2024-12-13T17:23:49Z

ecal/core/src/service/ecal_service_server_impl.h

    int RequestCallback(const std::string& request_pb_, std::string& response_pb_);
-    void EventCallback(eCAL_Server_Event event_, const std::string& message_);
+    void NotifyEventCallback(const Registration::SServiceMethodId& service_id_, eCAL_Server_Event event_type_, const std::string& message_);


warning: no header providing "eCAL_Server_Event" is directly included [misc-include-cleaner]

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

- #include "serialization/ecal_serialize_sample_registration.h" + #include "ecal/cimpl/ecal_callback_cimpl.h" + #include "serialization/ecal_serialize_sample_registration.h"

github-actions · 2024-12-13T17:23:49Z

ecal/core/src/service/ecal_service_server_impl.h

+    // Server connection state and synchronization
+    mutable std::mutex                     m_connected_mutex; // mutex protecting m_connected (modified by the event callbacks in another thread)
+    bool                                   m_connected = false;
+    std::atomic<bool>                      m_created;


warning: no header providing "std::atomic" is directly included [misc-include-cleaner]

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

- #include <ecal/ecal_callback.h> + #include <atomic> + #include <ecal/ecal_callback.h>

github-actions · 2024-12-13T17:23:49Z

ecal/core/src/service/ecal_service_server_v5.cpp

+**/
+
+#include <ecal/ecal.h>
+#include <ecal/ecal_server_v5.h>


warning: included header ecal.h is not used directly [misc-include-cleaner]

Suggested change

#include <ecal/ecal_server_v5.h>

#include <ecal/ecal_server_v5.h>

github-actions · 2024-12-13T17:23:49Z

ecal/core/src/service/ecal_service_server_v5.cpp

+#include <string>
+
+#include "ecal_servicegate.h"
+#include "ecal_global_accessors.h"


warning: included header ecal_servicegate.h is not used directly [misc-include-cleaner]

Suggested change

#include "ecal_global_accessors.h"

#include "ecal_global_accessors.h"

github-actions

clang-tidy made some suggestions

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

github-actions · 2024-12-13T17:50:26Z

ecal/core/src/service/ecal_service_server_v5.cpp

+
+#include "ecal_servicegate.h"
+#include "ecal_global_accessors.h"
+#include "ecal_service_server_v5_impl.h"


warning: included header ecal_global_accessors.h is not used directly [misc-include-cleaner]

Suggested change

#include "ecal_service_server_v5_impl.h"

#include "ecal_service_server_v5_impl.h"

github-actions · 2024-12-13T17:50:26Z

ecal/core/src/service/ecal_service_server_v5.cpp

+    bool CServiceServer::Create(const std::string& service_name_)
+    {
+      if (m_service_server_impl != nullptr) return false;
+      m_service_server_impl = std::make_shared<CServiceServerImpl>(service_name_);


warning: no header providing "std::make_shared" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_v5.cpp:25:

- #include <string> + #include <memory> + #include <string>

github-actions · 2024-12-13T17:50:26Z

ecal/core/src/service/ecal_service_server_v5.cpp

+      return m_service_server_impl->AddDescription(method_, req_type_, req_desc_, resp_type_, resp_desc_);
+    }
+
+    bool CServiceServer::AddMethodCallback(const std::string& method_, const std::string& req_type_, const std::string& resp_type_, const MethodCallbackT& callback_)


warning: no header providing "eCAL::MethodCallbackT" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_v5.cpp:27:

- #include "ecal_servicegate.h" + #include "ecal/ecal_service_info.h" + #include "ecal_servicegate.h"

github-actions · 2024-12-13T17:50:26Z

ecal/core/src/service/ecal_service_server_v5.cpp

+      return m_service_server_impl->RemMethodCallback(method_);
+    }
+
+    bool CServiceServer::AddEventCallback(eCAL_Server_Event type_, ServerEventCallbackT callback_)


warning: no header providing "eCAL::ServerEventCallbackT" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_v5.cpp:27:

- #include "ecal_servicegate.h" + #include "ecal/ecal_callback.h" + #include "ecal_servicegate.h"

github-actions · 2024-12-13T17:50:26Z

ecal/core/src/service/ecal_service_server_v5.cpp

+      return m_service_server_impl->RemMethodCallback(method_);
+    }
+
+    bool CServiceServer::AddEventCallback(eCAL_Server_Event type_, ServerEventCallbackT callback_)


warning: no header providing "eCAL_Server_Event" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_v5.cpp:27:

- #include "ecal_servicegate.h" + #include "ecal/cimpl/ecal_callback_cimpl.h" + #include "ecal_servicegate.h"

github-actions · 2024-12-13T17:50:28Z

ecal/core/src/service/ecal_service_server_v5_impl.cpp

+          }
+        };
+
+      m_service_server_impl = std::make_shared<eCAL::CServiceServer>(service_name_, event_callback);


warning: no header providing "eCAL::CServiceServer" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_v5_impl.cpp:26:

+ #include "ecal/ecal_server.h"

github-actions · 2024-12-13T17:50:28Z

ecal/core/src/service/ecal_service_server_v5_impl.cpp

+          }
+        };
+
+      m_service_server_impl = std::make_shared<eCAL::CServiceServer>(service_name_, event_callback);


warning: no header providing "std::make_shared" is directly included [misc-include-cleaner]

ecal/core/src/service/ecal_service_server_v5_impl.cpp:24:

+ #include <memory>

github-actions · 2024-12-13T17:50:28Z

ecal/core/src/service/ecal_service_server_v5_impl.cpp

+        };
+
+      m_service_server_impl = std::make_shared<eCAL::CServiceServer>(service_name_, event_callback);
+      Logging::Log(log_level_debug1, "v5::CServiceServerImpl: Service server created with name: " + service_name_);


warning: no header providing "log_level_debug1" is directly included [misc-include-cleaner]

Logging::Log(log_level_debug1, "v5::CServiceServerImpl: Service server created with name: " + service_name_); ^

github-actions · 2024-12-13T17:50:28Z

ecal/core/src/service/ecal_service_server_v5_impl.cpp

+
+      if (!m_service_server_impl)
+      {
+        Logging::Log(log_level_error, "v5::CServiceServerImpl: Service server not initialized, cannot add description.");


warning: no header providing "log_level_error" is directly included [misc-include-cleaner]

Logging::Log(log_level_error, "v5::CServiceServerImpl: Service server not initialized, cannot add description."); ^

github-actions · 2024-12-13T17:50:28Z

ecal/core/src/service/ecal_service_server_v5_impl.cpp

+        return false;
+      }
+
+      SServiceMethodInformation method_info;


warning: no header providing "eCAL::SServiceMethodInformation" is directly included [misc-include-cleaner]

SServiceMethodInformation method_info; ^

rex-schilasky added 5 commits December 6, 2024 16:48

v5 renaming

91741af

intermediate commit

e79fa88

intermediate commit (building, not working)

a2ccd10

intermediate commit

9d2bf06

commenting

d9d7177

m_created removed

rex-schilasky marked this pull request as draft December 9, 2024 19:12

rex-schilasky added the cherry-pick-to-NONE Don't cherry-pick these changes label Dec 9, 2024

rex-schilasky mentioned this pull request Dec 9, 2024

cleanup service client api #1848

Closed

rex-schilasky changed the title ~~redesign server api~~ redesign service server api Dec 9, 2024

github-actions bot reviewed Dec 9, 2024

View reviewed changes

rex-schilasky added 11 commits December 10, 2024 14:16

first server implementation

3f9de03

service gate aligned with client gate service configuration removed

Merge branch 'master' into feature/redesign-service-api

8e9fa32

Merge branch 'master' into feature/client-api-cleanup

7011eaa

commenting, logging + minor fix

63082f3

eCAL::v5::CServiceServerImpl implemented based on eCAL::CServiceServer

ffa87a5

tests adapted

missing include

4181604

logging improved

02e8ad1

minor comment and include fixes

f59b100

improved logging

a5fb463

Merge branch 'feature/client-api-cleanup' into feature/redesign-servi…

c89f8ee

…ce-api

formatting

95187e9

missing include

rex-schilasky marked this pull request as ready for review December 11, 2024 12:39

rex-schilasky changed the title ~~redesign service server api~~ [core] redesign service server api Dec 11, 2024

github-actions bot reviewed Dec 11, 2024

View reviewed changes

rex-schilasky added 6 commits December 12, 2024 13:26

minor review adaptions

f9d9a0a

shared_ptr handling, commenting

c327a90

check for nullptr in destructor

2ccc9c1

logging added/improved for CServiceClientImpl and CServiceServerImpl

7bb8b57

GetServiceID added to public API of CServerClient and CServiceServer …

995c66c

…(not implemented yet)

review results

238b326

Merge branch 'master' into feature/redesign-service-api

1f41360

Peguen approved these changes Dec 13, 2024

View reviewed changes

github-actions bot reviewed Dec 13, 2024

View reviewed changes

server/client samples updated to v6

3f9a963

minimal warning fix in CDataReader (lock name change) TODO's added for CServiceServer and CServiceClient

github-actions bot reviewed Dec 13, 2024

View reviewed changes

minor test fix

d1cb855

github-actions bot reviewed Dec 13, 2024

View reviewed changes

rex-schilasky merged commit 9cdfe52 into master Dec 13, 2024
20 checks passed

rex-schilasky deleted the feature/redesign-service-api branch December 13, 2024 18:22

	explicit CServiceServer(const std::string& service_name_, const ServerEventIDCallbackT event_callback_ = ServerEventIDCallbackT());
	explicit CServiceServer(const std::string& service_name_, ServerEventIDCallbackT event_callback_ = ServerEventIDCallbackT());

		{
		Logging::Log(log_level_debug2, "v5::CServiceClientImpl: Initializing default service client implementation.");

	Registration::SServiceMethodId CServiceClient::GetServiceId() const
	Registration::SServiceMethodId CServiceClient::GetServiceId()

	std::lock_guard<std::mutex> exec_lock(m_connection_map_mtx);
	std::lock_guard<std::mutex> const exec_lock(m_connection_map_mtx);

	Registration::SServiceMethodId CServiceServer::GetServiceId() const
	Registration::SServiceMethodId CServiceServer::GetServiceId()

	#include <ecal/ecal_server_v5.h>
	#include <ecal/ecal_server_v5.h>

	#include "ecal_global_accessors.h"
	#include "ecal_global_accessors.h"

	#include "ecal_service_server_v5_impl.h"
	#include "ecal_service_server_v5_impl.h"

[core] redesign service server api #1849

[core] redesign service server api #1849

Conversation

rex-schilasky commented Dec 9, 2024

Description

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot Dec 9, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot Dec 11, 2024

Choose a reason for hiding this comment

Peguen left a comment

Choose a reason for hiding this comment

Peguen Dec 12, 2024

Choose a reason for hiding this comment

Peguen Dec 12, 2024

Choose a reason for hiding this comment

Peguen Dec 12, 2024

Choose a reason for hiding this comment

Peguen Dec 12, 2024

Choose a reason for hiding this comment

Peguen Dec 12, 2024

Choose a reason for hiding this comment

Peguen Dec 13, 2024

Choose a reason for hiding this comment

Peguen Dec 13, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Dec 13, 2024

Choose a reason for hiding this comment

github-actions bot Dec 13, 2024

Choose a reason for hiding this comment

github-actions bot Dec 13, 2024

Choose a reason for hiding this comment

github-actions bot Dec 13, 2024

Choose a reason for hiding this comment

github-actions bot Dec 13, 2024

Choose a reason for hiding this comment

github-actions bot Dec 13, 2024

Choose a reason for hiding this comment

github-actions bot Dec 13, 2024