first draft of a new client api #1785

rex-schilasky · 2024-11-06T12:59:53Z

Description

THIS IS JUST A WORKING DRAFT FOR A NEW CLIENT API.

…esigned in next iteration, for now just for testing)

…rallel for now

github-actions

clang-tidy made some suggestions

github-actions · 2024-11-08T20:02:56Z

ecal/core/include/ecal/ecal_client_id.h

+  /**
+   * @brief Service client wrapper class.
+  **/
+  class CServiceClientID


warning: class 'CServiceClientID' defines a non-default 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 CServiceClientID ^

github-actions · 2024-11-08T20:02:57Z

ecal/core/src/service/ecal_clientgate.h


    void ApplyServiceRegistration(const Registration::Sample& ecal_sample_);

    void GetRegistrations(Registration::SampleList& reg_sample_list_);

  protected:
-    static std::atomic<bool>    m_created;
+    static std::atomic<bool>      m_created;


warning: variable 'm_created' is non-const and globally accessible, consider making it const [cppcoreguidelines-avoid-non-const-global-variables]

static std::atomic<bool> m_created; ^

github-actions · 2024-11-08T20:02:57Z

ecal/core/src/service/ecal_service_client_id.cpp

+  bool CServiceClientID::AddEventCallback(eCAL_Client_Event type_, ClientEventCallbackT callback_)
+  {
+    if (!m_service_client_impl) return false;
+    return m_service_client_impl->AddEventCallback(type_, callback_);


warning: parameter 'callback_' is passed by value and only copied once; consider moving it to avoid unnecessary copies [performance-unnecessary-value-param]

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

+ #include <utility>

Suggested change

return m_service_client_impl->AddEventCallback(type_, callback_);

return m_service_client_impl->AddEventCallback(type_, std::move(callback_));

github-actions · 2024-11-08T20:02:57Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+    }
+
+    // Create a response callback, that will set the response and notify the condition variable
+    eCAL::service::ClientResponseCallbackT response_callback


warning: variable 'response_callback' of type 'eCAL::service::ClientResponseCallbackT' (aka 'function<void (const eCAL::service::Error &, const shared_ptr<basic_string> &)>') can be declared 'const' [misc-const-correctness]

Suggested change

eCAL::service::ClientResponseCallbackT response_callback

eCAL::service::ClientResponseCallbackT const response_callback

github-actions

clang-tidy made some suggestions

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

github-actions · 2024-11-12T15:06:38Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+  void CServiceClientIDImpl::ResetAllCallbacks()
+  {
+    {
+      std::lock_guard<std::mutex> lock(m_client_session_map_sync);


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

Suggested change

std::lock_guard<std::mutex> lock(m_client_session_map_sync);

std::lock_guard<std::mutex> const lock(m_client_session_map_sync);

github-actions · 2024-11-12T15:06:38Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+      m_client_session_map.clear();
+    }
+    {
+      std::lock_guard<std::mutex> lock(m_response_callback_sync);


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

Suggested change

std::lock_guard<std::mutex> lock(m_response_callback_sync);

std::lock_guard<std::mutex> const lock(m_response_callback_sync);

github-actions · 2024-11-12T15:06:38Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+      m_response_callback = nullptr;
+    }
+    {
+      std::lock_guard<std::mutex> lock(m_event_callback_map_sync);


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

Suggested change

std::lock_guard<std::mutex> lock(m_event_callback_map_sync);

std::lock_guard<std::mutex> const lock(m_event_callback_map_sync);

github-actions · 2024-11-12T15:06:39Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+  // Adds a callback function for service responses
+  bool CServiceClientIDImpl::AddResponseCallback(const ResponseIDCallbackT& callback_)
+  {
+    std::lock_guard<std::mutex> lock(m_response_callback_sync);


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

Suggested change

std::lock_guard<std::mutex> lock(m_response_callback_sync);

std::lock_guard<std::mutex> const lock(m_response_callback_sync);

github-actions · 2024-11-12T15:06:39Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+  // Removes the service response callback
+  bool CServiceClientIDImpl::RemoveResponseCallback()
+  {
+    std::lock_guard<std::mutex> lock(m_response_callback_sync);


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

Suggested change

std::lock_guard<std::mutex> lock(m_response_callback_sync);

std::lock_guard<std::mutex> const lock(m_response_callback_sync);

github-actions · 2024-11-12T15:06:40Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+    };
+  }
+
+  SServiceResponse CServiceClientIDImpl::PrepareErrorResponse(const std::string& error_message)


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

ecal/core/src/service/ecal_service_client_id_impl.h:163:

- SServiceResponse PrepareErrorResponse(const std::string& error_message); + static SServiceResponse PrepareErrorResponse(const std::string& error_message);

github-actions · 2024-11-12T15:06:40Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+
+  void CServiceClientIDImpl::IncrementMethodCallCount(const std::string& method_name_)
+  {
+    std::lock_guard<std::mutex> lock(m_method_information_map_sync);


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

Suggested change

std::lock_guard<std::mutex> lock(m_method_information_map_sync);

std::lock_guard<std::mutex> const lock(m_method_information_map_sync);

github-actions · 2024-11-12T15:06:40Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+  // Check if a specific service is connected
+  bool CServiceClientIDImpl::IsConnected(const Registration::SEntityId& entity_id_)
+  {
+    std::lock_guard<std::mutex> lock(m_client_session_map_sync);


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

Suggested change

std::lock_guard<std::mutex> lock(m_client_session_map_sync);

std::lock_guard<std::mutex> const lock(m_client_session_map_sync);

github-actions · 2024-11-12T15:06:40Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+  // Check if any service is connected
+  bool CServiceClientIDImpl::IsConnected()
+  {
+    std::lock_guard<std::mutex> lock(m_client_session_map_sync);


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

Suggested change

std::lock_guard<std::mutex> lock(m_client_session_map_sync);

std::lock_guard<std::mutex> const lock(m_client_session_map_sync);

github-actions · 2024-11-12T15:06:40Z

ecal/core/src/service/ecal_service_client_id_impl.cpp

+
+  void CServiceClientIDImpl::RegisterService(const Registration::SEntityId& entity_id_, const SServiceAttr& service_)
+  {
+    std::lock_guard<std::mutex> lock(m_client_session_map_sync);


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

Suggested change

std::lock_guard<std::mutex> lock(m_client_session_map_sync);

std::lock_guard<std::mutex> const lock(m_client_session_map_sync);

first draft of a new client api (not implemented, not compiling)

dc49318

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

rex-schilasky added 4 commits November 6, 2024 15:24

minor change

72262ed

draft API with entity ids aligned with public client api (will be red…

cf7f3bc

…esigned in next iteration, for now just for testing)

new client api moved to separate units to introduce and test it in pa…

ffc4320

…rallel for now

extra qualification removed

fc55ad4

github-actions bot reviewed Nov 8, 2024

View reviewed changes

class restructured

1e3d759

github-actions bot reviewed Nov 12, 2024

View reviewed changes

rex-schilasky changed the title ~~first draft of a new client api (not implemented, not compiling)~~ first draft of a new client api Nov 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

first draft of a new client api #1785

first draft of a new client api #1785

rex-schilasky commented Nov 6, 2024

github-actions bot left a comment

github-actions bot Nov 8, 2024

github-actions bot Nov 8, 2024

github-actions bot Nov 8, 2024

github-actions bot Nov 8, 2024

github-actions bot left a comment

github-actions bot Nov 12, 2024

github-actions bot Nov 12, 2024

github-actions bot Nov 12, 2024

github-actions bot Nov 12, 2024

github-actions bot Nov 12, 2024

github-actions bot Nov 12, 2024

github-actions bot Nov 12, 2024

github-actions bot Nov 12, 2024

github-actions bot Nov 12, 2024

github-actions bot Nov 12, 2024

	return m_service_client_impl->AddEventCallback(type_, callback_);
	return m_service_client_impl->AddEventCallback(type_, std::move(callback_));

	eCAL::service::ClientResponseCallbackT response_callback
	eCAL::service::ClientResponseCallbackT const response_callback

	std::lock_guard<std::mutex> lock(m_client_session_map_sync);
	std::lock_guard<std::mutex> const lock(m_client_session_map_sync);

	std::lock_guard<std::mutex> lock(m_response_callback_sync);
	std::lock_guard<std::mutex> const lock(m_response_callback_sync);

	std::lock_guard<std::mutex> lock(m_event_callback_map_sync);
	std::lock_guard<std::mutex> const lock(m_event_callback_map_sync);

	std::lock_guard<std::mutex> lock(m_method_information_map_sync);
	std::lock_guard<std::mutex> const lock(m_method_information_map_sync);

first draft of a new client api #1785

Are you sure you want to change the base?

first draft of a new client api #1785

Conversation

rex-schilasky commented Nov 6, 2024

Description

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Nov 8, 2024

Choose a reason for hiding this comment

github-actions bot Nov 8, 2024

Choose a reason for hiding this comment

github-actions bot Nov 8, 2024

Choose a reason for hiding this comment

github-actions bot Nov 8, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment

github-actions bot Nov 12, 2024

Choose a reason for hiding this comment