[core] protobuf service client to v6 by rex-schilasky · Pull Request #1981 · eclipse-ecal/ecal

rex-schilasky · 2025-01-30T19:46:13Z

Refactor Protobuf Client API

This pull request introduces a major update and refactoring of the Protobuf-based service client API. The old API for CServiceClient has been replaced with a more robust, flexible, and type-safe design that separates untyped and typed interfaces.

Key Changes

New API Structure:
- Untyped Interface (CServiceClient):
  - Provides templated methods for synchronous and asynchronous calls.
  - Returns untyped responses (SServiceResponse).
  - Methods:
    - CallWithResponse<RequestT>()
    - CallWithCallback<RequestT>()
    - CallWithCallbackAsync<RequestT>()
- Typed Interface (CServiceClientTyped):
  - Offers templated methods for calls where both request and response types are specified.
  - Automatically parses raw responses into strongly typed objects.
  - Methods:
    - CallWithResponse<RequestT, ResponseT>()
    - CallWithCallback<RequestT, ResponseT>()
    - CallWithCallbackAsync<RequestT, ResponseT>()
New Client Instance Wrappers:
- CClientInstance: Handles untyped service calls.
- CClientInstanceTyped: Handles typed service calls and includes conversion of raw responses into the specified protobuf type.
Common Base Class (CServiceClientBase):
- Consolidates shared functionality (e.g., retrieving client instances and processing responses) between the untyped and typed clients.
- Parameterized on the service description type and the corresponding client instance type.
Improved Code Organization:
- Enhanced inline documentation for all classes and methods to aid developers in usage and future maintenance.

Impact & Migration

Enhanced Maintainability & Flexibility:
- The refactored design allows for clearer semantics and better type safety.
- Provides a cleaner separation of concerns between untyped and typed service calls.
Breaking Changes:
- The old CServiceClient interface is replaced. Users should migrate to:
  - eCAL::protobuf::CServiceClient for untyped calls.
  - eCAL::protobuf::CServiceClientTyped for calls that require typed responses.
- Update any existing call invocations to use the new templated methods (CallWithResponse, CallWithCallback, and CallWithCallbackAsync).
Migration Steps:
1. Replace instances of the old CServiceClient with the new interfaces.
2. Adjust service call invocations to match the new method signatures.
3. For typed responses, ensure that the correct request and response types are provided as template parameters.

Code Snippet Old and New API

1. Client Construction & Callback Registration

Old API:

// Create math service client using the old API
eCAL::protobuf::CServiceClient<MathService> math_client;

// Register response callback (using untyped responses)
math_client.AddResponseCallback(OnMathResponse);

// Register event callbacks (using v5 callback signature)
math_client.AddEventCallback(eCAL::eClientEvent::connected,    std::bind(OnClientState, std::placeholders::_2));
math_client.AddEventCallback(eCAL::eClientEvent::disconnected, std::bind(OnClientState, std::placeholders::_2));
math_client.AddEventCallback(eCAL::eClientEvent::timeout,      std::bind(OnClientState, std::placeholders::_2));

New API:

// Create a typed math service client with an inline client state callback
const eCAL::protobuf::CServiceClientTyped<MathService> math_client(OnClientState);

// (Client state callback now receives both the service ID and event data)

2. Service Call Invocation

Old API (Untyped calls):

// Prepare the request message
SFloatTuple math_request;
math_request.set_inp1(inp1);
math_request.set_inp2(inp2);

// Asynchronous call (callback variant)
if (!math_client.Call("Add", math_request))
{
  std::cout << "MathService::Add method call failed." << std::endl;
}

// Synchronous (blocking) call
if (!math_client.Call("Multiply", math_request))
{
  std::cout << "MathService::Multiply method call failed." << std::endl;
}

New API (Typed calls):

// Prepare the request message
SFloatTuple math_request;
math_request.set_inp1(counter);
math_request.set_inp2(counter + 1);

// Asynchronous call (callback variant) with typed response:
if (!math_client.CallWithCallback<SFloatTuple, SFloat>("Add", math_request, OnMathResponse))
{
  std::cout << "MathService::Add call (callback) failed." << std::endl;
}

// Synchronous (blocking) call with typed response:
auto multiply_response = math_client.CallWithResponse<SFloatTuple, SFloat>("Multiply", math_request);
if (multiply_response.first)
{
  for (const auto& resp : multiply_response.second)
  {
    std::cout << "Blocking: Received Multiply response: " << resp.response.out() << std::endl;
  }
}
else
{
  std::cout << "Blocking: MathService::Multiply call failed!" << std::endl;
}

3. Iterating Over Client Instances

Old API:

// Directly call the service method on the client instance
math_client.Call("Divide", math_request);

New API:

// Retrieve individual client instances and call methods on each
auto instances = math_client.GetClientInstances();
for (auto& instance : instances)
{
  if (!instance.CallWithCallback<SFloatTuple, SFloat>("Divide", math_request, OnMathResponse))
  {
    std::cout << "MathService::Divide call on an instance failed." << std::endl;
  }
}

4. Callback Function Signatures

Old API (Untyped Response):

void OnMathResponse(const eCAL::v5::SServiceResponse& service_response)
{
  // Parse the raw response manually
  SFloat response;
  response.ParseFromString(service_response.response);
  std::cout << "Received response: " << response.out() << std::endl;
}

New API (Typed Response):

void OnMathResponse(const eCAL::protobuf::SMsgServiceResponse<SFloat>& service_response)
{
  // Directly access the parsed, typed response
  if (service_response.call_state == eCAL::eCallState::executed)
  {
    std::cout << "Callback: Received response: " << service_response.response.out() << std::endl;
  }
  else
  {
    std::cout << "Callback: Error: " << service_response.error_msg << std::endl;
  }
}

5. Client State Callback Signature

Old API:

void OnClientState(const eCAL::v5::SClientEventCallbackData* data)
{
  // Handle events using the old callback signature.
}

New API:

void OnClientState(const eCAL::SServiceId& service_id, const eCAL::SClientEventCallbackData& data)
{
  // Now the callback provides both the service identity and event data.
  std::cout << "Connected to service: " << service_id.service_name << std::endl;
}

These snippets illustrate the key changes:

Typed Interface: The new API uses CServiceClientTyped with templated methods for request/response types, eliminating manual parsing.
Improved Call Methods: New methods like CallWithCallback and CallWithResponse enforce type safety.
Enhanced Callbacks: Client state and response callbacks now deliver additional context (e.g., service ID) and typed responses.
Instance-Level Access: The new API enables per-instance service calls via GetClientInstances().

github-actions

clang-tidy made some suggestions

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

app/sys/sys_core/src/connection/remote_connection.cpp

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client.h

github-actions · 2025-02-05T12:38:14Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+    {
+    public:
+      // Constructors
+      CClientInstance(eCAL::CClientInstance&& base_instance_) noexcept


warning: rvalue reference parameter 'base_instance_' is never moved from inside the function body [cppcoreguidelines-rvalue-reference-param-not-moved]

CClientInstance(eCAL::CClientInstance&& base_instance_) noexcept ^

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

serialization/protobuf/protobuf/include/ecal/msg/protobuf/typed_response.h

serialization/protobuf/samples/services/math_client/src/math_client.cpp

… means all host in legacy logic)

github-actions

clang-tidy made some suggestions

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_typed_response.h

serialization/protobuf/samples/services/ping_client/src/ping_client.cpp

github-actions

clang-tidy made some suggestions

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client.h

github-actions

clang-tidy made some suggestions

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_response_parser.h

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_typed_response.h

… separate unit msg/protobuf/client_protobuf_utils.h

github-actions

clang-tidy made some suggestions

github-actions · 2025-02-06T10:35:45Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_utils.h

+
+#pragma once
+
+#include <ecal/service/client.h>


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

#include <ecal/service/client.h> ^

github-actions · 2025-02-06T10:35:45Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_utils.h

+
+      ServiceMethodInformationSetT method_information_set;
+      CProtoDynDecoder dyn_decoder;
+      std::string error_s;


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

Suggested change

std::string error_s;

std::string error_s = 0;

github-actions · 2025-02-06T10:35:45Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_utils.h

+        const std::string& request_type_name = method_descriptor->input_type()->name();
+        const std::string& response_type_name = method_descriptor->output_type()->name();
+
+        std::string request_type_descriptor;


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

Suggested change

std::string request_type_descriptor;

std::string request_type_descriptor = 0;

github-actions · 2025-02-06T10:35:45Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_utils.h

+        const std::string& response_type_name = method_descriptor->output_type()->name();
+
+        std::string request_type_descriptor;
+        std::string response_type_descriptor;


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

Suggested change

std::string response_type_descriptor;

std::string response_type_descriptor = 0;

DEFAULT_TIME_ARGUMENT

github-actions

clang-tidy made some suggestions

github-actions · 2025-02-07T09:46:58Z

app/rec/rec_server_cli/src/commands/command.h

+        static eCAL::rec::Error GetRemoteConfig(const std::string& hostname, const std::shared_ptr<eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::rec_server::EcalRecServerService>>& remote_rec_server_service, eCAL::rec_server::RecServerConfig& config_output);

-        static eCAL::rec::Error CallRemoteEcalrecService(const std::shared_ptr<eCAL::protobuf::CServiceClient<eCAL::pb::rec_server::EcalRecServerService>>& remote_ecalsys_service
+        static eCAL::rec::Error CallRemoteEcalrecService(const std::shared_ptr<eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::rec_server::EcalRecServerService>>& remote_ecalsys_service


warning: function 'eCAL::rec_cli::command::Command::CallRemoteEcalrecService' has a definition with different parameter names [readability-inconsistent-declaration-parameter-name]

static eCAL::rec::Error CallRemoteEcalrecService(const std::shared_ptr<eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::rec_server::EcalRecServerService>>& remote_ecalsys_service ^

Additional context

app/rec/rec_server_cli/src/commands/command.cpp:75: the definition seen here

eCAL::rec::Error Command::CallRemoteEcalrecService(const std::shared_ptr<eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::rec_server::EcalRecServerService>>& remote_ecalrec_service ^

app/rec/rec_server_cli/src/commands/command.h:63: differing parameters are named here: ('remote_ecalsys_service'), in definition: ('remote_ecalrec_service')

static eCAL::rec::Error CallRemoteEcalrecService(const std::shared_ptr<eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::rec_server::EcalRecServerService>>& remote_ecalsys_service ^

github-actions · 2025-02-07T09:46:59Z

app/rec/rec_server_cli/src/ecal_rec_server_cli.cpp

 // Rec Sever instance and rec_server_service. We will only use one of those, depending on the remote-control setting
 std::shared_ptr<eCAL::rec_server::RecServer>                                                rec_server_instance;
-std::shared_ptr<eCAL::protobuf::CServiceClient<eCAL::pb::rec_server::EcalRecServerService>> remote_rec_server_service;
+std::shared_ptr<eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::rec_server::EcalRecServerService>> remote_rec_server_service;


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

std::shared_ptr<eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::rec_server::EcalRecServerService>> remote_rec_server_service; ^

github-actions · 2025-02-07T09:46:59Z

ecal/samples/cpp/orchestration/orchestrator/src/orchestrator.cpp


-  eCAL::protobuf::CServiceClient<orchestrator::ComponentService> component1("component1");
-  eCAL::protobuf::CServiceClient<orchestrator::ComponentService> component2("component2");
+  eCAL::protobuf::CServiceClientTypedResponse<orchestrator::ComponentService> component1("component1");


warning: variable 'component1' of type 'eCAL::protobuf::CServiceClientTypedResponseorchestrator::ComponentService' can be declared 'const' [misc-const-correctness]

Suggested change

eCAL::protobuf::CServiceClientTypedResponse<orchestrator::ComponentService> component1("component1");

eCAL::protobuf::CServiceClientTypedResponse<orchestrator::ComponentService> const component1("component1");

github-actions · 2025-02-07T09:46:59Z

ecal/samples/cpp/orchestration/orchestrator/src/orchestrator.cpp

-  eCAL::protobuf::CServiceClient<orchestrator::ComponentService> component1("component1");
-  eCAL::protobuf::CServiceClient<orchestrator::ComponentService> component2("component2");
+  eCAL::protobuf::CServiceClientTypedResponse<orchestrator::ComponentService> component1("component1");
+  eCAL::protobuf::CServiceClientTypedResponse<orchestrator::ComponentService> component2("component2");


warning: variable 'component2' of type 'eCAL::protobuf::CServiceClientTypedResponseorchestrator::ComponentService' can be declared 'const' [misc-const-correctness]

Suggested change

eCAL::protobuf::CServiceClientTypedResponse<orchestrator::ComponentService> component2("component2");

eCAL::protobuf::CServiceClientTypedResponse<orchestrator::ComponentService> const component2("component2");

github-actions · 2025-02-07T09:46:59Z

samples/cpp/services/ecalplayer_client/src/ecalplayer_client.cpp

  // create player service client
-  eCAL::protobuf::CServiceClient<eCAL::pb::play::EcalPlayService> player_service;
-  player_service.AddResponseCallback(OnPlayerResponse);
+  eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::play::EcalPlayService> player_service;


warning: variable 'player_service' of type 'eCAL::protobuf::CServiceClientUntypedCallbackeCAL::pb::play::EcalPlayService' can be declared 'const' [misc-const-correctness]

Suggested change

eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::play::EcalPlayService> player_service;

eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::play::EcalPlayService> const player_service;

github-actions · 2025-02-07T09:47:00Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_callback_base.h

+    {
+    public:
+      using CServiceClientBase<T>::CServiceClientBase;
+      virtual ~CServiceClientCallbackBase() override = default;


warning: 'virtual' is redundant since the function is already declared 'override' [cppcoreguidelines-explicit-virtual-functions]

Suggested change

virtual ~CServiceClientCallbackBase() override = default;

;

github-actions · 2025-02-07T09:47:00Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h

+
+#pragma once
+
+#include <ecal/service/types.h>


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

#include <ecal/service/types.h> ^

github-actions · 2025-02-07T09:47:00Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h

+     * @tparam ResponseT The expected protobuf response type.
+     */
+    template <typename ResponseT>
+    struct TMsgServiceResponse


warning: constructor does not initialize these fields: server_id, service_method_information, error_msg [cppcoreguidelines-pro-type-member-init]

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h:50:

- SServiceId server_id; //!< Identifier of the server that executed the call - SServiceMethodInformation service_method_information; //!< Information about the called method + SServiceId server_id{}; //!< Identifier of the server that executed the call + SServiceMethodInformation service_method_information{}; //!< Information about the called method

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h:54:

- std::string error_msg; //!< Error message if the call failed + std::string error_msg{}; //!< Error message if the call failed

github-actions · 2025-02-07T09:47:01Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_response_base.h

+     * This class will serve as the parent for the typed and untyped variants.
+     */
+    template <typename T>
+    class CServiceClientResponseBase : public CServiceClientBase<T>


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

> ^

github-actions · 2025-02-07T09:47:01Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_response_base.h

+    {
+    public:
+      using CServiceClientBase<T>::CServiceClientBase; // Inherit constructors
+      virtual ~CServiceClientResponseBase() override = default;


warning: 'virtual' is redundant since the function is already declared 'override' [cppcoreguidelines-explicit-virtual-functions]

Suggested change

virtual ~CServiceClientResponseBase() override = default;

s

…ed and untyped reponse

github-actions

clang-tidy made some suggestions

ecal/samples/cpp/orchestration/orchestrator/src/orchestrator.cpp

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client.h

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

github-actions · 2025-02-09T15:14:21Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+    {
+    public:
+      // Constructors
+      CClientInstanceTyped(eCAL::CClientInstance&& base_instance_) noexcept


warning: rvalue reference parameter 'base_instance_' is never moved from inside the function body [cppcoreguidelines-rvalue-reference-param-not-moved]

CClientInstanceTyped(eCAL::CClientInstance&& base_instance_) noexcept ^

github-actions · 2025-02-09T15:14:21Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+      {
+      }
+
+      CClientInstanceTyped(const SEntityId& entity_id_, const std::shared_ptr<eCAL::CServiceClientImpl>& service_client_impl_)


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

CClientInstanceTyped(const SEntityId& entity_id_, const std::shared_ptr<eCAL::CServiceClientImpl>& service_client_impl_) ^

github-actions · 2025-02-09T15:14:21Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h

+     * @tparam ResponseT The expected protobuf response type.
+     */
+    template <typename ResponseT>
+    struct TMsgServiceResponse


warning: constructor does not initialize these fields: server_id, service_method_information, error_msg [cppcoreguidelines-pro-type-member-init]

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h:50:

- SServiceId server_id; //!< Identifier of the server that executed the call - SServiceMethodInformation service_method_information; //!< Information about the called method + SServiceId server_id{}; //!< Identifier of the server that executed the call + SServiceMethodInformation service_method_information{}; //!< Information about the called method

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h:54:

- std::string error_msg; //!< Error message if the call failed + std::string error_msg{}; //!< Error message if the call failed

Peguen · 2025-02-10T15:03:05Z

Apps and service samples tested in vm environment on windows and several ubuntu machines - working as expected.

rex-schilasky · 2025-02-10T15:26:59Z

Danke 🫶

github-actions

clang-tidy made some suggestions

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

github-actions · 2025-02-11T13:33:30Z

ecal/core/src/pubsub/ecal_publisher_impl.cpp

  }

-  bool CPublisherImpl::SetAttribute(const std::string& /* attr_name_ */_, const std::string& /* attr_value_ */)
+  bool CPublisherImpl::SetAttribute(const std::string& /* attr_name_ */, const std::string& /* attr_value_ */)


warning: method 'SetAttribute' can be made const [readability-make-member-function-const]

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

- bool SetAttribute(const std::string& attr_name_, const std::string& attr_value_); + bool SetAttribute(const std::string& attr_name_, const std::string& attr_value_) const;

Suggested change

bool CPublisherImpl::SetAttribute(const std::string& /* attr_name_ */, const std::string& /* attr_value_ */)

bool CPublisherImpl::SetAttribute(const std::string& /* attr_name_ */, const std::string& /* attr_value_ */) const

github-actions · 2025-02-11T13:33:30Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_instances_typed_test.cpp

+ * ========================= eCAL LICENSE =================================
+*/
+
+#include <ecal/ecal.h>


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

#include <ecal/ecal.h> ^

github-actions · 2025-02-11T13:33:31Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_instances_typed_test.cpp

+
+#include "math_service_impl.h"
+
+enum {


warning: enum '(unnamed enum at /github/workspace/serialization/protobuf/tests/clientserver_proto_test/src/clientserver_instances_typed_test.cpp:36:1)' uses a larger base type ('unsigned int', size: 4 bytes) than necessary for its value set, consider using 'std::uint16_t' (2 bytes) as the base type to reduce its size [performance-enum-size]

enum { ^

github-actions · 2025-02-11T13:33:31Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_instances_typed_test.cpp

+//
+// Iterative Client Instance Tests (Typed Math - Blocking)
+//
+TEST(core_cpp_clientserver_proto, IterativeClientInstances_Typed_Math)


warning: all parameters should be named in a function [readability-named-parameter]

Suggested change

TEST(core_cpp_clientserver_proto, IterativeClientInstances_Typed_Math)

TEST(core_cpp_clientserver_proto /*unused*/, IterativeClientInstances_Typed_Math /*unused*/)

github-actions · 2025-02-11T13:33:31Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_instances_typed_test.cpp

+//
+// Iterative Client Instance Tests (Typed Math - Callback)
+//
+TEST(core_cpp_clientserver_proto, IterativeClientInstances_Typed_Math_Callback)


warning: all parameters should be named in a function [readability-named-parameter]

Suggested change

TEST(core_cpp_clientserver_proto, IterativeClientInstances_Typed_Math_Callback)

TEST(core_cpp_clientserver_proto /*unused*/, IterativeClientInstances_Typed_Math_Callback /*unused*/)

github-actions · 2025-02-11T13:33:32Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+  eCAL::Finalize();
+}
+
+TEST(core_cpp_clientserver_proto, TypedCallbackAsync_Math)


warning: all parameters should be named in a function [readability-named-parameter]

Suggested change

TEST(core_cpp_clientserver_proto, TypedCallbackAsync_Math)

TEST(core_cpp_clientserver_proto /*unused*/, TypedCallbackAsync_Math /*unused*/)

github-actions · 2025-02-11T13:33:32Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+
+  auto start = std::chrono::steady_clock::now();
+
+  bool initiated = math_client.CallWithCallbackAsync<SFloat>("Divide", request, callback);


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

Suggested change

bool initiated = math_client.CallWithCallbackAsync<SFloat>("Divide", request, callback);

bool initiated = false = math_client.CallWithCallbackAsync<SFloat>("Divide", request, callback);

github-actions · 2025-02-11T13:33:32Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+//
+// Typed Ping Service Tests
+//
+TEST(core_cpp_clientserver_proto, TypedBlocking_Ping)


warning: all parameters should be named in a function [readability-named-parameter]

Suggested change

TEST(core_cpp_clientserver_proto, TypedBlocking_Ping)

TEST(core_cpp_clientserver_proto /*unused*/, TypedBlocking_Ping /*unused*/)

github-actions · 2025-02-11T13:33:32Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+  eCAL::Finalize();
+}
+
+TEST(core_cpp_clientserver_proto, TypedCallback_Ping)


warning: all parameters should be named in a function [readability-named-parameter]

Suggested change

TEST(core_cpp_clientserver_proto, TypedCallback_Ping)

TEST(core_cpp_clientserver_proto /*unused*/, TypedCallback_Ping /*unused*/)

github-actions · 2025-02-11T13:33:32Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+    prom.set_value(resp.response->answer());
+  };
+
+  bool initiated = ping_client.CallWithCallback<PingResponse>("Ping", request, callback);


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

Suggested change

bool initiated = ping_client.CallWithCallback<PingResponse>("Ping", request, callback);

bool initiated = false = ping_client.CallWithCallback<PingResponse>("Ping", request, callback);

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.

github-actions · 2025-02-11T15:14:11Z

serialization/protobuf/tests/clientserver_proto_test/src/atomic_signalable.h

+    return newValue;
+  }
+
+  T operator++(T) 


warning: all parameters should be named in a function [readability-named-parameter]

Suggested change

T operator++(T)

T operator++(T /*unused*/)

github-actions · 2025-02-11T15:14:11Z

serialization/protobuf/tests/clientserver_proto_test/src/atomic_signalable.h

+    return newValue;
+  }
+
+  T operator--(T) 


warning: all parameters should be named in a function [readability-named-parameter]

Suggested change

T operator--(T)

T operator--(T /*unused*/)

github-actions · 2025-02-11T15:14:11Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_event_test.cpp

+ * ========================= eCAL LICENSE =================================
+*/
+
+#include <ecal/ecal.h>


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

#include <ecal/ecal.h> ^

github-actions · 2025-02-11T15:14:11Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_event_test.cpp

+#include "math_service_impl.h"
+#include "ping_service_impl.h"
+
+enum { CMN_REGISTRATION_REFRESH_MS = 1000 };


warning: enum '(unnamed enum at /github/workspace/serialization/protobuf/tests/clientserver_proto_test/src/clientserver_event_test.cpp:37:1)' uses a larger base type ('unsigned int', size: 4 bytes) than necessary for its value set, consider using 'std::uint16_t' (2 bytes) as the base type to reduce its size [performance-enum-size]

enum { CMN_REGISTRATION_REFRESH_MS = 1000 }; ^

github-actions · 2025-02-11T15:14:11Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_event_test.cpp

+
+enum { CMN_REGISTRATION_REFRESH_MS = 1000 };
+
+TEST(core_cpp_clientserver_proto, ClientConnectEvent)


warning: all parameters should be named in a function [readability-named-parameter]

Suggested change

TEST(core_cpp_clientserver_proto, ClientConnectEvent)

TEST(core_cpp_clientserver_proto /*unused*/, ClientConnectEvent /*unused*/)

github-actions · 2025-02-11T15:14:13Z

serialization/protobuf/tests/clientserver_proto_test/src/math_service_impl.h

+  }
+
+  // Implements the "Multiply" RPC.
+  void Multiply(::google::protobuf::RpcController* /*controller*/,


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

Suggested change

void Multiply(::google::protobuf::RpcController* /*controller*/,

static void Multiply(::google::protobuf::RpcController* /*controller*/,

github-actions · 2025-02-11T15:14:13Z

serialization/protobuf/tests/clientserver_proto_test/src/math_service_impl.h

+  // Implements the "Multiply" RPC.
+  void Multiply(::google::protobuf::RpcController* /*controller*/,
+                const SFloatTuple* request,
+                SFloat* response,


warning: pointer parameter 'response' can be pointer to const [readability-non-const-parameter]

Suggested change

SFloat* response,

const SFloat* response,

github-actions · 2025-02-11T15:14:13Z

serialization/protobuf/tests/clientserver_proto_test/src/math_service_impl.h

+  void Multiply(::google::protobuf::RpcController* /*controller*/,
+                const SFloatTuple* request,
+                SFloat* response,
+                ::google::protobuf::Closure* done) override


warning: pointer parameter 'done' can be pointer to const [readability-non-const-parameter]

Suggested change

::google::protobuf::Closure* done) override

const ::google::protobuf::Closure* done) override

github-actions · 2025-02-11T15:14:13Z

serialization/protobuf/tests/clientserver_proto_test/src/math_service_impl.h

+  }
+
+  // Implements the "Divide" RPC.
+  void Divide(::google::protobuf::RpcController* /*controller*/,


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

Suggested change

void Divide(::google::protobuf::RpcController* /*controller*/,

static void Divide(::google::protobuf::RpcController* /*controller*/,

github-actions · 2025-02-11T15:14:13Z

serialization/protobuf/tests/clientserver_proto_test/src/math_service_impl.h

+  // Implements the "Divide" RPC.
+  void Divide(::google::protobuf::RpcController* /*controller*/,
+              const SFloatTuple* request,
+              SFloat* response,


warning: pointer parameter 'response' can be pointer to const [readability-non-const-parameter]

Suggested change

SFloat* response,

const SFloat* response,

KerstinKeller

I think that this is a very, very, very good first step in the right direction.

I am unsure about the typed vs. untyped client versions. I'd vote to keep only the typed ones, since in my opinion you are using protobuf in order to get the typing support in the first place!

The client instances should not use the dynamic messages to decode the responses.
And we need to take a look at the response Type, if the message should be stored in a shared_ptr or not.

I am a bit unsure. If we do it, we should also change it in the Message subscribers. It is maybe a bit connected to error handling in message subscribers. #1988

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client.h

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

sligthly improved error handling in case ParseFromString fails

github-actions

clang-tidy made some suggestions

github-actions · 2025-02-12T14:26:36Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+    {
+    public:
+      // Constructors
+      CClientInstance(eCAL::CClientInstance&& base_instance_) noexcept


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

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h:197:

- eCAL::CClientInstance m_instance; + eCAL::CClientInstance m_instance{};

github-actions · 2025-02-12T14:26:36Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+      {
+      }
+
+      CClientInstance(const SEntityId& entity_id_,


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

CClientInstance(const SEntityId& entity_id_, ^

github-actions · 2025-02-12T14:26:36Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+    {
+    public:
+      // Constructors
+      CClientInstanceTyped(eCAL::CClientInstance&& base_instance_) noexcept


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

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h:320:

- eCAL::CClientInstance m_instance; + eCAL::CClientInstance m_instance{};

github-actions · 2025-02-12T14:26:36Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+      {
+      }
+
+      CClientInstanceTyped(const SEntityId& entity_id_,


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

CClientInstanceTyped(const SEntityId& entity_id_, ^

github-actions · 2025-02-12T14:26:36Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+        auto ret = m_instance.CallWithResponse(method_name_, serialized_request, timeout_ms_);
+        TMsgServiceResponse<ResponseT> msg_response = ConvertResponse<ResponseT>(ret.second);
+
+        bool success = ret.first && (msg_response.call_state == eCallState::executed);


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

Suggested change

bool success = ret.first && (msg_response.call_state == eCallState::executed);

bool success = false = ret.first && (msg_response.call_state == eCallState::executed);

github-actions · 2025-02-12T14:26:37Z

serialization/protobuf/tests/clientserver_proto_test/src/math_service_impl.h

+  void Divide(::google::protobuf::RpcController* /*controller*/,
+              const SFloatTuple* request,
+              SFloat* response,
+              ::google::protobuf::Closure* done) override


warning: pointer parameter 'done' can be pointer to const [readability-non-const-parameter]

Suggested change

::google::protobuf::Closure* done) override

const ::google::protobuf::Closure* done) override

github-actions · 2025-02-12T14:26:37Z

serialization/protobuf/tests/clientserver_proto_test/src/ping_service_impl.h

+
+#pragma once
+
+#include "ping.pb.h"


warning: 'ping.pb.h' file not found [clang-diagnostic-error]

#include "ping.pb.h" ^

github-actions · 2025-02-12T14:26:37Z

serialization/protobuf/tests/clientserver_proto_test/src/ping_service_impl.h

+{
+public:
+  // Implements the "Ping" RPC.
+  void Ping(::google::protobuf::RpcController* /*controller*/,


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

Suggested change

void Ping(::google::protobuf::RpcController* /*controller*/,

static void Ping(::google::protobuf::RpcController* /*controller*/,

github-actions · 2025-02-12T14:26:37Z

serialization/protobuf/tests/clientserver_proto_test/src/ping_service_impl.h

+  // Implements the "Ping" RPC.
+  void Ping(::google::protobuf::RpcController* /*controller*/,
+            const PingRequest* /*request*/,
+            PingResponse* response,


warning: pointer parameter 'response' can be pointer to const [readability-non-const-parameter]

Suggested change

PingResponse* response,

const PingResponse* response,

github-actions · 2025-02-12T14:26:37Z

serialization/protobuf/tests/clientserver_proto_test/src/ping_service_impl.h

+  void Ping(::google::protobuf::RpcController* /*controller*/,
+            const PingRequest* /*request*/,
+            PingResponse* response,
+            ::google::protobuf::Closure* done) override


warning: pointer parameter 'done' can be pointer to const [readability-non-const-parameter]

Suggested change

::google::protobuf::Closure* done) override

const ::google::protobuf::Closure* done) override

github-actions

clang-tidy made some suggestions

github-actions · 2025-02-12T15:00:17Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h

+     * @tparam ResponseT The expected protobuf response type.
+     */
+    template <typename ResponseT>
+    struct SMsgServiceResponse


warning: constructor does not initialize these fields: server_id, service_method_information, error_msg [cppcoreguidelines-pro-type-member-init]

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h:46:

- SServiceId server_id; //!< Identifier of the server that executed the call - SServiceMethodInformation service_method_information; //!< Information about the called method + SServiceId server_id{}; //!< Identifier of the server that executed the call + SServiceMethodInformation service_method_information{}; //!< Information about the called method

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_protobuf_types.h:50:

- std::string error_msg; //!< Error message if the call failed + std::string error_msg{}; //!< Error message if the call failed

github-actions

clang-tidy made some suggestions

github-actions · 2025-02-13T08:22:54Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+    {
+    public:
+      // Constructors
+      CClientInstance(eCAL::CClientInstance&& base_instance_) noexcept


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

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h:188:

- eCAL::CClientInstance m_instance; + eCAL::CClientInstance m_instance{};

github-actions · 2025-02-13T08:22:54Z

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h

+    {
+    public:
+      // Constructors
+      CClientInstanceTyped(eCAL::CClientInstance&& base_instance_) noexcept


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

serialization/protobuf/protobuf/include/ecal/msg/protobuf/client_instance.h:312:

- eCAL::CClientInstance m_instance; + eCAL::CClientInstance m_instance{};

github-actions · 2025-02-13T08:22:54Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_instances_typed_test.cpp

+  request.set_inp1(100.0);
+  request.set_inp2(50.0);
+
+  auto result = math_client.CallWithResponse<SFloatTuple, SFloat>("Multiply", request);


warning: multiple declarations in a single statement reduces readability [readability-isolate-declaration]

Suggested change

auto result = math_client.CallWithResponse<SFloatTuple, SFloat>("Multiply", request);

auto result = math_client.CallWithResponse<SFloatTuple;

auto SFloat>("Multiply";("Multiply", request);

github-actions · 2025-02-13T08:22:54Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+  request.set_inp1(20.0);
+  request.set_inp2(22.0);
+
+  auto result = math_client.CallWithResponse<SFloatTuple, SFloat>("Add", request);


warning: multiple declarations in a single statement reduces readability [readability-isolate-declaration]

Suggested change

auto result = math_client.CallWithResponse<SFloatTuple, SFloat>("Add", request);

auto result = math_client.CallWithResponse<SFloatTuple;

auto SFloat>("Add";("Add", request);

github-actions · 2025-02-13T08:22:54Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+    prom.set_value(resp.response.out());
+  };
+
+  bool initiated = math_client.CallWithCallback<SFloatTuple, SFloat>("Divide", request, callback);


warning: multiple declarations in a single statement reduces readability [readability-isolate-declaration]

Suggested change

bool initiated = math_client.CallWithCallback<SFloatTuple, SFloat>("Divide", request, callback);

bool initiated = math_client.CallWithCallback<SFloatTuple;

bool SFloat>("Divide";("Divide", request, callback);

github-actions · 2025-02-13T08:22:55Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+
+  auto start = std::chrono::steady_clock::now();
+
+  bool initiated = math_client.CallWithCallbackAsync<SFloatTuple, SFloat>("Divide", request, callback);


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

bool initiated = math_client.CallWithCallbackAsync<SFloatTuple, SFloat>("Divide", request, callback); ^

this fix will not be applied because it overlaps with another fix

github-actions · 2025-02-13T08:22:55Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+  PingRequest request;
+  request.set_message("PING");
+
+  auto result = ping_client.CallWithResponse<PingRequest, PingResponse>("Ping", request);


warning: multiple declarations in a single statement reduces readability [readability-isolate-declaration]

Suggested change

auto result = ping_client.CallWithResponse<PingRequest, PingResponse>("Ping", request);

auto result = ping_client.CallWithResponse<PingRequest;

auto PingResponse>("Ping";("Ping", request);

github-actions · 2025-02-13T08:22:55Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+    prom.set_value(resp.response.answer());
+  };
+
+  bool initiated = ping_client.CallWithCallback<PingRequest, PingResponse>("Ping", request, callback);


warning: multiple declarations in a single statement reduces readability [readability-isolate-declaration]

Suggested change

bool initiated = ping_client.CallWithCallback<PingRequest, PingResponse>("Ping", request, callback);

bool initiated = ping_client.CallWithCallback<PingRequest;

bool PingResponse>("Ping";("Ping", request, callback);

github-actions · 2025-02-13T08:22:55Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+    prom.set_value(resp.response.answer());
+  };
+
+  bool initiated = ping_client.CallWithCallback<PingRequest, PingResponse>("Ping", request, callback);


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

bool initiated = ping_client.CallWithCallback<PingRequest, PingResponse>("Ping", request, callback); ^

this fix will not be applied because it overlaps with another fix

github-actions · 2025-02-13T08:22:55Z

serialization/protobuf/tests/clientserver_proto_test/src/clientserver_typed_test.cpp

+    prom.set_value(resp.response.answer());
+  };
+
+  bool initiated = ping_client.CallWithCallback<PingRequest, PingResponse>("Ping", request, callback);


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

bool initiated = ping_client.CallWithCallback<PingRequest, PingResponse>("Ping", request, callback); ^

this fix will not be applied because it overlaps with another fix

KerstinKeller

Let's merge and continue from there.

rex-schilasky added 2 commits January 30, 2025 20:42

msg/protobuf/client ported to v6 API

6e0351b

Merge branch 'master' into core/msg-protobuf-client-v6

90971a4

rex-schilasky added the cherry-pick-to-NONE Don't cherry-pick these changes label Jan 30, 2025

rex-schilasky added 3 commits January 31, 2025 10:50

Merge branch 'master' into core/msg-protobuf-client-v6

a505730

first version of templated protobuf msg client

062d117

missing template

08439bf

github-actions bot reviewed Feb 5, 2025

View reviewed changes

Merge branch 'master' into core/msg-protobuf-client-v6

0bf022a

hannemn mentioned this pull request Feb 5, 2025

eCAL 6 Serialization / Msg API Review #1988

Closed

6 tasks

FlorianReimold added this to the eCAL 6 milestone Feb 6, 2025

host name handling fixed if client instances are used (empty hostname…

bfc0538

… means all host in legacy logic)

github-actions bot reviewed Feb 6, 2025

View reviewed changes

hannemn linked an issue Feb 6, 2025 that may be closed by this pull request

eCAL 6 Serialization / Msg API Review #1988

Closed

6 tasks

clang tidy + CMakeLists.txt fix

078b245

github-actions bot reviewed Feb 6, 2025

View reviewed changes

separate response parser

0cdd6e2

github-actions bot reviewed Feb 6, 2025

View reviewed changes

rex-schilasky added 2 commits February 6, 2025 11:16

GetServiceNameFromDescriptor and CreateServiceMethodInformationSet in…

7ff7b07

… separate unit msg/protobuf/client_protobuf_utils.h

comments fixed

43879f4

rex-schilasky marked this pull request as ready for review February 6, 2025 10:19

github-actions bot reviewed Feb 6, 2025

View reviewed changes

rex-schilasky added 3 commits February 7, 2025 09:18

S.O.L.I.D

6e78300

ServiceResponse -> SServiceResponse

5d48292

DEFAULT_TIME_ARGUMENT

DEFAULT_TIME_ARGUMENT -> eCAL::protobuf namespace

47937a4

github-actions bot reviewed Feb 7, 2025

View reviewed changes

rex-schilasky added 3 commits February 9, 2025 15:11

back to single client.h with only 2 different implementation with typ…

db68781

…ed and untyped reponse

single client_instance.h with typed and untyped versions

5a21d24

typo

62ae1e1

github-actions bot reviewed Feb 9, 2025

View reviewed changes

rule of 5, constness

d7f652e

hannemn requested a review from KerstinKeller February 11, 2025 09:19

rex-schilasky added 2 commits February 11, 2025 12:42

Merge branch 'master' into core/msg-protobuf-client-v6

aec88c4

client server proto test rewritten (event tests needs to be added)

600992a

github-actions bot reviewed Feb 11, 2025

View reviewed changes

event test added

0fe5bb9

github-actions bot reviewed Feb 11, 2025

View reviewed changes

KerstinKeller requested changes Feb 12, 2025

View reviewed changes

rex-schilasky added 2 commits February 12, 2025 13:49

Merge branch 'master' into core/msg-protobuf-client-v6

19d9132

shared_ptr<ResponseT> -> ResponseT

7f1ae60

sligthly improved error handling in case ParseFromString fails

github-actions bot reviewed Feb 12, 2025

View reviewed changes

rex-schilasky added 2 commits February 12, 2025 15:38

header cleanup

db8c73d

TMsgService* -> SMsgService*

968806e

github-actions bot reviewed Feb 12, 2025

View reviewed changes

introduce request template parameter

21a98b8

github-actions bot reviewed Feb 13, 2025

View reviewed changes

KerstinKeller approved these changes Feb 13, 2025

View reviewed changes

rex-schilasky merged commit db3f4f1 into master Feb 13, 2025
26 checks passed

rex-schilasky deleted the core/msg-protobuf-client-v6 branch February 13, 2025 14:38

	std::string request_type_descriptor;
	std::string request_type_descriptor = 0;

	std::string response_type_descriptor;
	std::string response_type_descriptor = 0;

	eCAL::protobuf::CServiceClientTypedResponse<orchestrator::ComponentService> component1("component1");
	eCAL::protobuf::CServiceClientTypedResponse<orchestrator::ComponentService> const component1("component1");

	eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::play::EcalPlayService> player_service;
	eCAL::protobuf::CServiceClientUntypedCallback<eCAL::pb::play::EcalPlayService> const player_service;

	bool CPublisherImpl::SetAttribute(const std::string& /* attr_name_ /, const std::string& / attr_value_ */)
	bool CPublisherImpl::SetAttribute(const std::string& /* attr_name_ /, const std::string& / attr_value_ */) const

	TEST(core_cpp_clientserver_proto, IterativeClientInstances_Typed_Math)
	TEST(core_cpp_clientserver_proto /unused/, IterativeClientInstances_Typed_Math /unused/)

	TEST(core_cpp_clientserver_proto, TypedCallbackAsync_Math)
	TEST(core_cpp_clientserver_proto /unused/, TypedCallbackAsync_Math /unused/)


		auto start = std::chrono::steady_clock::now();

		bool initiated = math_client.CallWithCallbackAsync<SFloat>("Divide", request, callback);

	bool initiated = math_client.CallWithCallbackAsync<SFloat>("Divide", request, callback);
	bool initiated = false = math_client.CallWithCallbackAsync<SFloat>("Divide", request, callback);

	TEST(core_cpp_clientserver_proto, TypedBlocking_Ping)
	TEST(core_cpp_clientserver_proto /unused/, TypedBlocking_Ping /unused/)

	bool initiated = ping_client.CallWithCallback<PingResponse>("Ping", request, callback);
	bool initiated = false = ping_client.CallWithCallback<PingResponse>("Ping", request, callback);


		enum { CMN_REGISTRATION_REFRESH_MS = 1000 };

		TEST(core_cpp_clientserver_proto, ClientConnectEvent)

	void Multiply(::google::protobuf::RpcController* /controller/,
	static void Multiply(::google::protobuf::RpcController* /controller/,

	::google::protobuf::Closure* done) override
	const ::google::protobuf::Closure* done) override

	void Divide(::google::protobuf::RpcController* /controller/,
	static void Divide(::google::protobuf::RpcController* /controller/,

	bool success = ret.first && (msg_response.call_state == eCallState::executed);
	bool success = false = ret.first && (msg_response.call_state == eCallState::executed);

	void Ping(::google::protobuf::RpcController* /controller/,
	static void Ping(::google::protobuf::RpcController* /controller/,

	auto result = math_client.CallWithResponse<SFloatTuple, SFloat>("Multiply", request);
	auto result = math_client.CallWithResponse<SFloatTuple;
	auto SFloat>("Multiply";("Multiply", request);

	auto result = math_client.CallWithResponse<SFloatTuple, SFloat>("Add", request);
	auto result = math_client.CallWithResponse<SFloatTuple;
	auto SFloat>("Add";("Add", request);

	bool initiated = math_client.CallWithCallback<SFloatTuple, SFloat>("Divide", request, callback);
	bool initiated = math_client.CallWithCallback<SFloatTuple;
	bool SFloat>("Divide";("Divide", request, callback);

Conversation

rex-schilasky commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Refactor Protobuf Client API

Key Changes

Impact & Migration

Code Snippet Old and New API

1. Client Construction & Callback Registration

2. Service Call Invocation

3. Iterating Over Client Instances

4. Callback Function Signatures

5. Client State Callback Signature

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot Feb 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 7, 2025

rex-schilasky commented Jan 30, 2025 •

edited

Loading

	auto result = ping_client.CallWithResponse<PingRequest, PingResponse>("Ping", request);
	auto result = ping_client.CallWithResponse<PingRequest;
	auto PingResponse>("Ping";("Ping", request);

	bool initiated = ping_client.CallWithCallback<PingRequest, PingResponse>("Ping", request, callback);
	bool initiated = ping_client.CallWithCallback<PingRequest;
	bool PingResponse>("Ping";("Ping", request, callback);