Tools.h

Go to the documentation of this file.

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

#ifndef DDS_TOOLS_H
#define DDS_TOOLS_H

// DDS
#include "ToolsProtocol.h"
// STD
#include <iostream>
#include <mutex>
#include <string>
// BOOST
#include <boost/property_tree/ptree.hpp>
#include <boost/uuid/uuid.hpp>

namespace dds
{
    namespace tools_api
    {
        class CSession
        {
          public:
            enum class EAgentState
            {
                active = 0,
                idle,
                executing
            };

            CSession();
            ~CSession();
            boost::uuids::uuid create();
            void attach(const std::string& _sid);
            void attach(const boost::uuids::uuid& _sid);
            void shutdown();
            void detach();
            bool IsRunning() const;
            boost::uuids::uuid getSessionID() const;
            static std::string getDefaultSessionIDString();
            static boost::uuids::uuid getDefaultSessionID();
            static void setup();

            void blockCurrentThread();
            void unblockCurrentThread();

            template <class T>
            void sendRequest(typename T::ptr_t _request);

            template <class Request_t>
            void syncSendRequest(const typename Request_t::request_t& _requestData,
                                 const std::chrono::seconds& _timeout = std::chrono::seconds(0),
                                 std::ostream* _out = nullptr);

            template <class Request_t>
            void syncSendRequest(const typename Request_t::request_t& _requestData,
                                 typename Request_t::response_t& _responseData,
                                 const std::chrono::seconds& _timeout = std::chrono::seconds(0),
                                 std::ostream* _out = nullptr);

            template <class Request_t>
            void syncSendRequest(const typename Request_t::request_t& _requestData,
                                 typename Request_t::responseVector_t& _responseDataVector,
                                 const std::chrono::seconds& _timeout = std::chrono::seconds(0),
                                 std::ostream* _out = nullptr);

            template <CSession::EAgentState _state>
            void waitForNumAgents(size_t _numAgents,
                                  const std::chrono::seconds& _timeout = std::chrono::seconds(0),
                                  const std::chrono::milliseconds& _requestInterval = std::chrono::milliseconds(500),
                                  std::ostream* _out = nullptr);

            std::string userDefaultsGetValueForKey(const std::string& _key) const noexcept;

          private:
            void subscribe();
            bool isDDSAvailable() const;

            void notify(std::istream& _stream);

            // Map request ID to the actual request object
            typedef std::map<requestID_t, boost::any> requests_t;

            template <class T>
            void processRequest(requests_t::mapped_type _request,
                                const boost::property_tree::ptree::value_type& _child,
                                std::function<void(typename T::ptr_t)> _processResponseCallback);

            struct SImpl;
            std::shared_ptr<SImpl> m_impl;

            std::mutex m_mtxRequests;
        };
    } // namespace tools_api
} // namespace dds

#endif /* DDS_TOOLS_H */