ToolsProtocolCore.h

Go to the documentation of this file.

// Copyright 2019 GSI, Inc. All rights reserved.
//
//
//

#ifndef DDS_TOOLSPROTOCOLCORE_H
#define DDS_TOOLSPROTOCOLCORE_H

// STD
#include <string>
// BOOST
#include <boost/crc.hpp>
#include <boost/property_tree/json_parser.hpp>
#include <boost/uuid/uuid.hpp>
#include <boost/uuid/uuid_generators.hpp>
#include <boost/uuid/uuid_io.hpp>

/*
{
    "dds": {
        "tools-api": {
            "message": {
                "msg": "string",
                "severity": 123,
                "requestID": 123
            },
            "done": {
                "requestID": 123
            },
            "progress":{
                "completed": 123,
                "total": 123,
                "errors": 123,
                "time": 123,
                "srcCommand": 123
            },
            "submit": {
                "rms": "string",
                "instances": 123,
                "config": "string",
                "pluginPath": "string",
                "requestID": 123
            },
            "topology": {
                "updateType": 123,
                "topologyFile": "string",
                "disableValidation": false,
                "requestID": 123
            },
            "getlog": {
                "requestID": 123
            },
            "commanderInfo":
            {
                "pid":123,
                "idleAgentsCount": 123,
                "activeTopologyName": "string",
                "requestID": 123
            },
            "agentInfo":
            {
                "index": 0,
                "lobbyLeader" : true,
                "agentID": 3456,
                "taskID": 5678,
                "startUpTime": 12345,
                "agentState": "executing",
                "username": "user1"
                "host": "host1",
                "DDSPath": "/path/to/dds",
                "agentPid": 34
                "requestID": 123
            },
            "agentCount":
            {
                "activeSlotsCount": 123,
                "idleSlotsCount" : 234,
                "executingSlotsCount": 345,
                "requestID": 123
            },
            "subscribeOnTaskDone":
            {
                "requestID": 123
            },
            "taskDone":
            {
                "requestID": 123,
                "taskID": 123,
                "exitCode": 123,
                "signal": 123
            }
            "agentCommand":
            {
                "command": 123,
                "arg1": 123,
                "arg2": "string"
            }
        }
    }
}
*/

#define DDS_TOOLS_DECLARE_DATA_CLASS(theBaseClass, theClass, theTag) \
    struct theClass : theBaseClass<theClass>                         \
    {                                                                \
        theClass()                                                   \
        {                                                            \
        }                                                            \
        theClass(const boost::property_tree::ptree& _pt)             \
        {                                                            \
            fromPT(_pt);                                             \
        }                                                            \
                                                                     \
      private:                                                       \
        friend SBaseData<theClass>;                                  \
        friend theBaseClass<theClass>;                               \
        void _fromPT(const boost::property_tree::ptree& /*_pt*/)     \
        {                                                            \
        }                                                            \
        void _toPT(boost::property_tree::ptree& /*_pt*/) const       \
        {                                                            \
        }                                                            \
        static constexpr const char* _protocolTag = theTag;          \
                                                                     \
      public:                                                        \
        bool operator==(const theClass& _val) const                  \
        {                                                            \
            return SBaseData::operator==(_val);                      \
        }                                                            \
    };

namespace dds
{
    namespace tools_api
    {
        typedef uint64_t requestID_t;

        template <class T>
        struct SBaseData
        {
            requestID_t m_requestID = 0;

            std::string toJSON() const
            {
                boost::property_tree::ptree pt;

                toPT(pt);

                boost::property_tree::ptree ptParent;

                auto parentPtr = static_cast<const T*>(this);
                ptParent.put_child("dds.tools-api." + std::string(parentPtr->_protocolTag), pt);

                std::stringstream json;
                boost::property_tree::write_json(json, ptParent);

                return json.str();
            }

            void toPT(boost::property_tree::ptree& _pt) const
            {
                auto parentPtr{ static_cast<const T*>(this) };
                _pt.put<requestID_t>("requestID", m_requestID);
                parentPtr->_toPT(_pt);
            }

            void fromPT(const boost::property_tree::ptree& _pt)
            {
                auto parentPtr{ static_cast<T*>(this) };
                m_requestID = _pt.get<uint64_t>("requestID", 0);
                parentPtr->_fromPT(_pt);
            }

            bool operator==(const T& _val) const
            {
                return (m_requestID == _val.m_requestID);
            }

            friend std::ostream& operator<<(std::ostream& _os, const SBaseData& _data)
            {
                auto parentPtr = static_cast<const T*>(_data);
                return _os << "requestID: " << _data.m_requestID << "; protocolTag: " << parentPtr->_protocolTag;
            }

            std::string defaultToString() const
            {
                std::stringstream ss;
                auto parentPtr = static_cast<const T*>(this);
                ss << "requestID: " << m_requestID << "; protocolTag: " << parentPtr->_protocolTag;
                return ss.str();
            }
        };

        template <class T>
        struct SBaseRequestData : public SBaseData<T>
        {
        };

        template <class T>
        struct SBaseResponseData : public SBaseData<T>
        {
        };

        struct SEmptyResponseData : SBaseResponseData<SEmptyResponseData>
        {
          private:
            friend SBaseResponseData<SEmptyResponseData>;
            void _fromPT(const boost::property_tree::ptree& /*_pt*/)
            {
                throw std::runtime_error("DDS Tools API: bad usage of SEmptyResponseData");
            }

            void _toPT(boost::property_tree::ptree& /*_pt*/) const
            {
                throw std::runtime_error("DDS Tools API: bad usage of SEmptyResponseData");
            }
            static std::string _protocolTag()
            {
                throw std::runtime_error("DDS Tools API: bad usage of SEmptyResponseData");
            }

          public:
            bool operator==(const SEmptyResponseData& /*_val*/) const
            {
                throw std::runtime_error("DDS Tools API: bad usage of SEmptyRequestData");
            }
        };

        // forward declaration
        struct SDoneResponseData;
        struct SMessageResponseData;
        struct SProgressResponseData;

        template <class TRequest, class TResponse>
        struct SBaseRequestImpl
        {
            using response_t = TResponse;
            using request_t = TRequest;
            using responseVector_t = std::vector<response_t>;

            typedef std::shared_ptr<SBaseRequestImpl> ptr_t;

            typedef std::function<void(const response_t&)> callbackResponse_t;
            typedef std::function<void(const SProgressResponseData&)> callbackProgress_t;
            typedef std::function<void(const SMessageResponseData&)> callbackMessage_t;
            typedef std::function<void()> callbackDone_t;

          public:
            static ptr_t makeRequest(const request_t& _request)
            {
                // we don't use make_shared here, becasue the constructor is private
                auto ptr = std::shared_ptr<SBaseRequestImpl>(new SBaseRequestImpl());
                requestID_t requestID = ptr->m_request.m_requestID;
                ptr->m_request = _request;
                ptr->m_request.m_requestID = requestID;
                return ptr;
            }

            void setResponseCallback(callbackResponse_t _callbackResponse)
            {
                m_callbackResponse = _callbackResponse;
            }

            void setProgressCallback(callbackProgress_t _callbackProgress)
            {
                m_callbackProgress = _callbackProgress;
            }

            void setMessageCallback(callbackMessage_t _callbackMessage)
            {
                m_callbackMessage = _callbackMessage;
            }

            void setDoneCallback(callbackDone_t _callbackDone)
            {
                m_callbackDone = _callbackDone;
            }

            void execResponseCallback(const response_t& _arg)
            {
                try
                {
                    if (m_callbackResponse)
                        m_callbackResponse(_arg);
                }
                catch (const std::exception& e)
                {
                    throw std::runtime_error(std::string("ResponseCallback: ") + e.what());
                }
            }

            void execProgressCallback(const SProgressResponseData& _arg)
            {
                try
                {
                    if (m_callbackProgress)
                        m_callbackProgress(_arg);
                }
                catch (const std::exception& e)
                {
                    throw std::runtime_error(std::string("ProgressCallback: ") + e.what());
                }
            }

            void execMessageCallback(const SMessageResponseData& _arg)
            {
                try
                {
                    if (m_callbackMessage)
                        m_callbackMessage(_arg);
                }
                catch (const std::exception& e)
                {
                    throw std::runtime_error(std::string("MessageCallback: ") + e.what());
                }
            }

            void execDoneCallback()
            {
                try
                {
                    if (m_callbackDone)
                        m_callbackDone();
                }
                catch (const std::exception& e)
                {
                    throw std::runtime_error(std::string("DoneCallback: ") + e.what());
                }
            }

            const request_t& getRequest() const
            {
                return m_request;
            }

          protected:
            SBaseRequestImpl()
            {
                const boost::uuids::uuid id = boost::uuids::random_generator()();
                std::stringstream strid;
                strid << id;

                m_request.m_requestID = crc64(strid.str());
            }
            SBaseRequestImpl(const SBaseRequestImpl&);

            uint64_t crc64(const std::string& _str)
            {
                boost::crc_optimal<64, 0x04C11DB7, 0, 0, false, false> crc;
                crc.process_bytes(_str.data(), _str.size());
                return crc.checksum();
            }

          private:
            callbackResponse_t m_callbackResponse;
            callbackProgress_t m_callbackProgress;
            callbackMessage_t m_callbackMessage;
            callbackDone_t m_callbackDone;

            request_t m_request;
        };
    } // namespace tools_api
} // namespace dds

#endif /* DDS_TOOLSPROTOCOLCORE_H */