dds_intercom.h

Go to the documentation of this file.

// Copyright 2014 GSI, Inc. All rights reserved.
//
//
//
#ifndef DDS_INTERCOM_H_
#define DDS_INTERCOM_H_
// STD
#include <string>
// BOOST
#include "dds_intercom_error_codes.h"
#include <boost/property_tree/json_parser.hpp>
#include <boost/signals2/signal.hpp>

namespace dds
{
    namespace intercom_api
    {
        // DDS intercom service
        class CIntercomService
        {
          public:
            ~CIntercomService();

            void subscribeOnError(errorSignal_t::slot_function_type _subscriber);
            void start(const std::string& _sessionID = "");
        };

        // DDS key-value
        class CKeyValue
        {
          public:
            typedef boost::signals2::signal<void(
                const std::string& /*_propertyID*/, const std::string& /*_key*/, const std::string& /*_value*/)>
                signal_t;

            typedef boost::signals2::signal<void(const std::string& /*_propertyID*/, const std::string& /*_key*/)>
                deleteSignal_t;

          public:
            CKeyValue(CIntercomService& _service);
            ~CKeyValue();

          public:
            void putValue(const std::string& _key, const std::string& _value);
            void subscribe(signal_t::slot_function_type _subscriber);
            void subscribeOnDelete(deleteSignal_t::slot_function_type _subscriber);
            void unsubscribe();

          public:
            CIntercomService& m_service; 
        };

        // DDS custom commands
        class CCustomCmd
        {
          public:
            typedef boost::signals2::signal<void(
                const std::string& /*_command*/, const std::string& /*_condition*/, uint64_t /*_senderID*/)>
                signal_t;
            typedef boost::signals2::signal<void(const std::string&)> replySignal_t;

          public:
            CCustomCmd(CIntercomService& _service);
            ~CCustomCmd();

          public:
            void send(const std::string& _command, const std::string& _condition);
            void subscribe(signal_t::slot_function_type _subscriber);
            void subscribeOnReply(replySignal_t::slot_function_type _subscriber);
            void unsubscribe();

          public:
            CIntercomService& m_service; 
        };

        // DDS RMS plugins

        const std::string g_sRmsAgentSign = "rms_agent_sign";

        enum class EMsgSeverity
        {
            info, 
            error 
        };

        struct SSubmit
        {
            SSubmit();

            std::string toJSON();

            void fromJSON(const std::string& _json);

            void fromPT(const boost::property_tree::ptree& _pt);

            bool operator==(const SSubmit& _val) const;

            uint32_t m_nInstances;        
            std::string m_cfgFilePath;    
            std::string m_id;             
            std::string m_wrkPackagePath; 
        };

        struct SMessage
        {
            SMessage();

            std::string toJSON();

            void fromJSON(const std::string& _json);

            void fromPT(const boost::property_tree::ptree& _pt);

            bool operator==(const SMessage& _val) const;

            EMsgSeverity m_msgSeverity; 
            std::string m_msg;          
            std::string m_id;           
        };

        struct SInit
        {
            SInit();

            std::string toJSON();

            void fromJSON(const std::string& _json);

            void fromPT(const boost::property_tree::ptree& _pt);

            bool operator==(const SInit& _val) const;

            std::string m_id; 
        };

        class CRMSPluginProtocol
        {
          public:
            typedef boost::signals2::signal<void(const SSubmit&)> signalSubmit_t;

            typedef boost::signals2::signal<void(const SMessage&)> signalMessage_t;

          public:
            CRMSPluginProtocol(const std::string& _id);

            ~CRMSPluginProtocol();

          public:
            void onSubmit(signalSubmit_t::slot_function_type _subscriber);

            void onMessage(signalMessage_t::slot_function_type _subscriber);

            void sendMessage(EMsgSeverity _severity, const std::string& _msg);

            void start(bool _block = true);

            void stop();

          protected:
            void notify(std::istream& _stream);

          private:
            void unsubscribe();

            signalSubmit_t m_signalSubmit;   
            signalMessage_t m_signalMessage; 

            std::string m_id; 

            CIntercomService m_service; 
            CCustomCmd m_customCmd;     
        };
    }
}

#endif /* DDS_INTERCOM_H_ */