MuditaOS/module-sys/Service/Message.hpp

#pragma once

#include "Common.hpp"
#include "MessageType.hpp"
#include <memory>
#include <stdint.h>
#include <string>
#include <vector>

namespace sys
{

    class Service;
    class ResponseMessage;
    class Message;

    enum class SystemMessageType
    {
        Ping,
        SwitchPowerMode,
        Start,
        Timer,
        Exit
    };

    using Message_t    = std::shared_ptr<Message>;
    using MessageRet_t = std::pair<ReturnCodes, std::shared_ptr<Message>>;

    MessageRet_t CreateMessageRet(ReturnCodes retCode, Message_t msg);

    class Message
    {

      public:
        enum class TransmissionType
        {
            Unicast,
            Multicast,
            Broadcast
        };

        enum class Type
        {
            System,
            Data,
            Response
        };

        Message()
        {
#ifdef UNIT_TESTS
            unitestsMsgInstancesCount++;
#endif
        }

        Message(BusChannels chan) : channel(chan)
        {
#ifdef UNIT_TESTS
            unitestsMsgInstancesCount++;
#endif
        }

        virtual ~Message()
        {
#ifdef UNIT_TESTS
            unitestsMsgInstancesCount--;
#endif
        }

        virtual Message_t Execute(Service *service) = 0;

        Type type;
        TransmissionType transType;
        BusChannels channel;
        std::string sender;
        uint64_t id;
        uint64_t uniID;

        virtual operator std::string() const
        {
            return "{}";
        }

#ifdef UNIT_TESTS
        static uint32_t unitestsMsgInstancesCount;
#endif
    };

    class SystemMessage : public Message
    {
      public:
        SystemMessage(SystemMessageType sysMsgType, ServicePowerMode pwrMode = ServicePowerMode::Active)
            : Message(BusChannels ::System), sysMsgType(sysMsgType), powerMode(pwrMode)
        {
            type = Type::System;
        }

        Message_t Execute(Service *service) override;

        SystemMessageType sysMsgType;
        ServicePowerMode powerMode;
    };

    class DataMessage : public Message
    {
      public:
        // This field must by provided by the class that inherits DataMessage
        MessageType messageType = MessageType::MessageTypeUninitialized;

        DataMessage(MessageType messageType) : messageType{messageType}
        {
            type = Type::Data;
        }

        DataMessage(BusChannels channel) : Message(channel)
        {
            type = Type::Data;
        }

        Message_t Execute(Service *service) override final;
    };

    class ResponseMessage : public Message
    {
      public:
        ResponseMessage(ReturnCodes retCode    = ReturnCodes::Success,
                        MessageType responseTo = MessageType::MessageTypeUninitialized)
            : Message(), responseTo(responseTo), retCode(retCode)
        {
            type = Type::Response;
        }
        MessageType responseTo;
        ReturnCodes retCode;

        Message_t Execute(Service *service) override;
    };

} // namespace sys