Test on RequestReplyListener for all Nodes

Signed-off-by: Javier Gil Aviles <[email protected]>
eProsima · Jan 15, 2025 · c0460e3 · c0460e3
1 parent 934a201
commit c0460e3
Show file tree

Hide file tree

Showing 22 changed files with 1,060 additions and 1 deletion.
diff --git a/sustainml_cpp/include/sustainml_cpp/core/Node.hpp b/sustainml_cpp/include/sustainml_cpp/core/Node.hpp
@@ -50,6 +50,7 @@ namespace core {
 class NodeImpl;
 class NodeControlListener;
 class Dispatcher;
+class RequestReplyListener;
 struct Options;
 
 /**
@@ -76,6 +77,15 @@ class Node
             const std::string& name,
             const Options& opts);
 
+    SUSTAINML_CPP_DLL_API Node(
+            const std::string& name,
+            RequestReplyListener& req_res_listener);
+
+    SUSTAINML_CPP_DLL_API Node(
+            const std::string& name,
+            const Options& opts,
+            RequestReplyListener& req_res_listener);
+
     SUSTAINML_CPP_DLL_API virtual ~Node();
 
     /**

diff --git a/sustainml_cpp/include/sustainml_cpp/core/RequestReplyListener.hpp b/sustainml_cpp/include/sustainml_cpp/core/RequestReplyListener.hpp
@@ -0,0 +1,68 @@
+// Copyright 2023 Proyectos y Sistemas de Mantenimiento SL (eProsima).
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @file RequestReplyListener.hpp
+ */
+
+#ifndef SUSTAINMLCPP_CORE_REQUESTREPLEIR_HPP
+#define SUSTAINMLCPP_CORE_REQUESTREPLEIR_HPP
+
+#include <sustainml_cpp/types/types.hpp>
+
+namespace sustainml {
+namespace core {
+
+/**
+ * @brief This class implement a virtual function for the configuration of each node.
+ * Each node will need to inherit it and implement their own.
+ * End user to implement specific callbacks to certain actions.
+ *
+ */
+class RequestReplyListener{
+
+public:
+
+    /**
+     * @brief Constructor
+     */
+    RequestReplyListener()
+    {
+    }
+
+    /**
+     * @brief Destructor
+     */
+    ~RequestReplyListener()
+    {
+    }
+
+    /**
+     * Virtual method to be called when a configuration request is received.
+     *
+     * @param req The request message
+     * @param res The response message to send
+     */
+    virtual void on_configuration_request(
+            types::RequestType& req,
+            types::ResponseType& res)
+    {
+    }
+
+};
+
+} // namespace core
+} // namespace sustainml
+
+#endif // SUSTAINMLCPP_CORE_REQUESTREPLEIR_HPP
diff --git a/sustainml_cpp/include/sustainml_cpp/nodes/AppRequirementsNode.hpp b/sustainml_cpp/include/sustainml_cpp/nodes/AppRequirementsNode.hpp
@@ -84,10 +84,19 @@ class AppRequirementsNode : public ::sustainml::core::Node
     SUSTAINML_CPP_DLL_API AppRequirementsNode(
             AppRequirementsTaskListener& user_listener);
 
+    SUSTAINML_CPP_DLL_API AppRequirementsNode(
+            AppRequirementsTaskListener& user_listener,
+            sustainml::core::RequestReplyListener& req_res_listener);
+
 #ifndef SWIG_WRAPPER
     SUSTAINML_CPP_DLL_API AppRequirementsNode(
             AppRequirementsTaskListener& user_listener,
             sustainml::core::Options opts);
+
+    SUSTAINML_CPP_DLL_API AppRequirementsNode(
+            AppRequirementsTaskListener& user_listener,
+            sustainml::core::Options opts,
+            sustainml::core::RequestReplyListener& req_res_listener);
 #endif // SWIG_WRAPPER
 
     SUSTAINML_CPP_DLL_API virtual ~AppRequirementsNode();

diff --git a/sustainml_cpp/include/sustainml_cpp/nodes/CarbonFootprintNode.hpp b/sustainml_cpp/include/sustainml_cpp/nodes/CarbonFootprintNode.hpp
@@ -91,10 +91,19 @@ class CarbonFootprintNode : public ::sustainml::core::Node
     SUSTAINML_CPP_DLL_API CarbonFootprintNode(
             CarbonFootprintTaskListener& listener);
 
+    SUSTAINML_CPP_DLL_API CarbonFootprintNode(
+        CarbonFootprintTaskListener& listener,
+        sustainml::core::RequestReplyListener& req_res_listener);
+
 #ifndef SWIG_WRAPPER
     SUSTAINML_CPP_DLL_API CarbonFootprintNode(
             CarbonFootprintTaskListener& listener,
             sustainml::core::Options opts);
+
+    SUSTAINML_CPP_DLL_API CarbonFootprintNode(
+            CarbonFootprintTaskListener& listener,
+            sustainml::core::Options opts,
+            sustainml::core::RequestReplyListener& req_res_listener);
 #endif // SWIG_WRAPPER
     SUSTAINML_CPP_DLL_API virtual ~CarbonFootprintNode();
 

diff --git a/sustainml_cpp/include/sustainml_cpp/nodes/HardwareConstraintsNode.hpp b/sustainml_cpp/include/sustainml_cpp/nodes/HardwareConstraintsNode.hpp
@@ -84,10 +84,19 @@ class HardwareConstraintsNode : public ::sustainml::core::Node
     SUSTAINML_CPP_DLL_API HardwareConstraintsNode(
             HardwareConstraintsTaskListener& user_listener);
 
+    SUSTAINML_CPP_DLL_API HardwareConstraintsNode(
+            HardwareConstraintsTaskListener& user_listener,
+            sustainml::core::RequestReplyListener& req_res_listener);
+
 #ifndef SWIG_WRAPPER
     SUSTAINML_CPP_DLL_API HardwareConstraintsNode(
             HardwareConstraintsTaskListener& user_listener,
             sustainml::core::Options opts);
+
+    SUSTAINML_CPP_DLL_API HardwareConstraintsNode(
+            HardwareConstraintsTaskListener& user_listener,
+            sustainml::core::Options opts,
+            sustainml::core::RequestReplyListener& req_res_listener);   
 #endif // SWIG_WRAPPER
 
     SUSTAINML_CPP_DLL_API virtual ~HardwareConstraintsNode();

diff --git a/sustainml_cpp/include/sustainml_cpp/nodes/HardwareResourcesNode.hpp b/sustainml_cpp/include/sustainml_cpp/nodes/HardwareResourcesNode.hpp
@@ -88,10 +88,19 @@ class HardwareResourcesNode : public ::sustainml::core::Node
     SUSTAINML_CPP_DLL_API HardwareResourcesNode(
             HardwareResourcesTaskListener& user_listener);
 
+    SUSTAINML_CPP_DLL_API HardwareResourcesNode(
+            HardwareResourcesTaskListener& user_listener,
+            sustainml::core::RequestReplyListener& req_res_listener);
+
 #ifndef SWIG_WRAPPER
     SUSTAINML_CPP_DLL_API HardwareResourcesNode(
             HardwareResourcesTaskListener& user_listener,
             sustainml::core::Options opts);
+
+    SUSTAINML_CPP_DLL_API HardwareResourcesNode(
+            HardwareResourcesTaskListener& user_listener,
+            sustainml::core::Options opts,
+            sustainml::core::RequestReplyListener& req_res_listener);
 #endif // SWIG_WRAPPER
 
     SUSTAINML_CPP_DLL_API virtual ~HardwareResourcesNode();

diff --git a/sustainml_cpp/include/sustainml_cpp/nodes/MLModelMetadataNode.hpp b/sustainml_cpp/include/sustainml_cpp/nodes/MLModelMetadataNode.hpp
@@ -84,10 +84,19 @@ class MLModelMetadataNode : public ::sustainml::core::Node
     SUSTAINML_CPP_DLL_API MLModelMetadataNode(
             MLModelMetadataTaskListener& user_listener);
 
+    SUSTAINML_CPP_DLL_API MLModelMetadataNode(
+            MLModelMetadataTaskListener& user_listener,
+            sustainml::core::RequestReplyListener& req_res_listener);
+
 #ifndef SWIG_WRAPPER
     SUSTAINML_CPP_DLL_API MLModelMetadataNode(
             MLModelMetadataTaskListener& user_listener,
             sustainml::core::Options opts);
+
+    SUSTAINML_CPP_DLL_API MLModelMetadataNode(
+            MLModelMetadataTaskListener& user_listener,
+            sustainml::core::Options opts,
+            sustainml::core::RequestReplyListener& req_res_listener);
 #endif // SWIG_WRAPPER
 
     SUSTAINML_CPP_DLL_API virtual ~MLModelMetadataNode();

diff --git a/sustainml_cpp/include/sustainml_cpp/nodes/MLModelNode.hpp b/sustainml_cpp/include/sustainml_cpp/nodes/MLModelNode.hpp
@@ -94,10 +94,19 @@ class MLModelNode : public ::sustainml::core::Node
     SUSTAINML_CPP_DLL_API MLModelNode(
             MLModelTaskListener& user_listener);
 
+    SUSTAINML_CPP_DLL_API MLModelNode(
+            MLModelTaskListener& user_listener,
+            sustainml::core::RequestReplyListener& req_res_listener);
+
 #ifndef SWIG_WRAPPER
     SUSTAINML_CPP_DLL_API MLModelNode(
             MLModelTaskListener& user_listener,
             sustainml::core::Options opts);
+
+    SUSTAINML_CPP_DLL_API MLModelNode(
+            MLModelTaskListener& user_listener,
+            sustainml::core::Options opts,
+            sustainml::core::RequestReplyListener& req_res_listener);
 #endif // SWIG_WRAPPER
 
     SUSTAINML_CPP_DLL_API virtual ~MLModelNode();

diff --git a/sustainml_cpp/src/cpp/core/Node.cpp b/sustainml_cpp/src/cpp/core/Node.cpp
@@ -37,6 +37,19 @@ namespace core {
         impl_ = new NodeImpl(this, name, opts);
     }
 
+    Node::Node(const std::string &name,
+               RequestReplyListener& req_res_listener)
+    {
+        impl_ = new NodeImpl(this, name, req_res_listener);
+    }
+
+    Node::Node(const std::string &name,
+               const Options& opts,
+               RequestReplyListener& req_res_listener)
+    {
+        impl_ = new NodeImpl(this, name, opts, req_res_listener);
+    }
+
     Node::~Node()
     {
         delete impl_;

diff --git a/sustainml_cpp/src/cpp/core/NodeImpl.cpp b/sustainml_cpp/src/cpp/core/NodeImpl.cpp
@@ -45,6 +45,7 @@ NodeImpl::NodeImpl(
     , publisher_(nullptr)
     , subscriber_(nullptr)
     , control_listener_(this)
+    , req_res_listener_(*new RequestReplyListener())
 {
     if (!init(name))
     {
@@ -62,6 +63,44 @@ NodeImpl::NodeImpl(
     , publisher_(nullptr)
     , subscriber_(nullptr)
     , control_listener_(this)
+    , req_res_listener_(*new RequestReplyListener())
+{
+    if (!init(name, opts))
+    {
+        EPROSIMA_LOG_ERROR(NODE, "Initialization Failed with the provided Options");
+    }
+}
+
+NodeImpl::NodeImpl(
+        Node* node,
+        const std::string& name,
+        RequestReplyListener& req_res_listener)
+    : node_(node)
+    , dispatcher_(new Dispatcher(node_))
+    , participant_(nullptr)
+    , publisher_(nullptr)
+    , subscriber_(nullptr)
+    , control_listener_(this)
+    , req_res_listener_(req_res_listener)
+{
+    if (!init(name))
+    {
+        EPROSIMA_LOG_ERROR(NODE, "Initialization Failed with the provided Options");
+    }
+}
+
+NodeImpl::NodeImpl(
+        Node* node,
+        const std::string& name,
+        const Options& opts,
+        RequestReplyListener& req_res_listener)
+    : node_(node)
+    , dispatcher_(new Dispatcher(node_))
+    , participant_(nullptr)
+    , publisher_(nullptr)
+    , subscriber_(nullptr)
+    , control_listener_(this)
+    , req_res_listener_(req_res_listener)
 {
     if (!init(name, opts))
     {

diff --git a/sustainml_cpp/src/cpp/core/NodeImpl.hpp b/sustainml_cpp/src/cpp/core/NodeImpl.hpp
@@ -23,6 +23,7 @@
 #include <sustainml_cpp/types/types.hpp>
 
 #include <core/Options.hpp>
+#include <core/RequestReplyListener.hpp>
 #include <types/typesImplPubSubTypes.hpp>
 
 #include <utility>
@@ -52,6 +53,7 @@ namespace core {
 
 class Dispatcher;
 class Node;
+class RequestReplyListener;
 struct Options;
 
 /**
@@ -81,6 +83,17 @@ class NodeImpl
             const std::string& name,
             const Options& opts);
 
+    NodeImpl(
+            Node* node,
+            const std::string& name,
+            RequestReplyListener& req_res_listener);
+
+    NodeImpl(
+            Node* node,
+            const std::string& name,
+            const Options& opts,
+            RequestReplyListener& req_res_listener);
+
     ~NodeImpl();
 
     /**
@@ -153,6 +166,8 @@ class NodeImpl
 
     NodeStatusImpl node_status_;
 
+    RequestReplyListener& req_res_listener_;
+
 private:
 
     /**

diff --git a/sustainml_cpp/src/cpp/nodes/AppRequirementsNode.cpp b/sustainml_cpp/src/cpp/nodes/AppRequirementsNode.cpp
@@ -23,6 +23,7 @@
 #include <common/Common.hpp>
 #include <core/Options.hpp>
 #include <core/QueuedNodeListener.hpp>
+#include <core/RequestReplyListener.hpp>
 #include <types/typesImpl.hpp>
 
 using namespace types;
@@ -49,6 +50,26 @@ AppRequirementsNode::AppRequirementsNode(
     init(opts);
 }
 
+AppRequirementsNode::AppRequirementsNode(
+        AppRequirementsTaskListener& user_listener,
+        sustainml::core::RequestReplyListener& req_res_listener)
+    : Node(common::APP_REQUIREMENTS_NODE, req_res_listener)
+    , user_listener_(user_listener)
+{
+    sustainml::core::Options opts;
+    opts.rqos.resource_limits().max_instances = 500;
+    opts.rqos.resource_limits().max_samples_per_instance = 1;
+    opts.rqos.durability().kind = eprosima::fastdds::dds::TRANSIENT_LOCAL_DURABILITY_QOS;
+    opts.rqos.reliability().kind = eprosima::fastdds::dds::RELIABLE_RELIABILITY_QOS;
+    opts.rqos.history().kind = eprosima::fastdds::dds::KEEP_LAST_HISTORY_QOS;
+    opts.rqos.history().depth = 1;
+
+    opts.wqos.resource_limits().max_instances = 500;
+    opts.wqos.resource_limits().max_samples_per_instance = 1;
+    opts.wqos.durability().kind = eprosima::fastdds::dds::TRANSIENT_LOCAL_DURABILITY_QOS;
+    init(opts);
+}
+
 AppRequirementsNode::AppRequirementsNode(
         AppRequirementsTaskListener& user_listener,
         sustainml::core::Options opts)
@@ -58,6 +79,16 @@ AppRequirementsNode::AppRequirementsNode(
     init(opts);
 }
 
+AppRequirementsNode::AppRequirementsNode(
+        AppRequirementsTaskListener& user_listener,
+        sustainml::core::Options opts,
+        sustainml::core::RequestReplyListener& req_res_listener)
+    : Node(common::APP_REQUIREMENTS_NODE, opts, req_res_listener)
+    , user_listener_(user_listener)
+{
+    init(opts);
+}
+
 AppRequirementsNode::~AppRequirementsNode()
 {