Socket.h

//
// Copyright 2014 - 2024 (C). Alex Robenko. All rights reserved.
//
 
// This file is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
#pragma once
 
#include <cstdint>
#include <cstddef>
#include <vector>
#include <functional>
 
#include <QtCore/QString>
 
#include "Api.h"
#include "DataInfo.h"
 
namespace cc_tools_qt
{
 
class CC_API Socket
{
public:
    enum ConnectionProperty
    {
        ConnectionProperty_Autoconnect = 0x1, 
        ConnectionProperty_NonDisconnectable = 0x2 
    };
 
    Socket();
 
    virtual ~Socket() noexcept;
 
    bool start();
 
    void stop();
 
    bool isRunning() const;
 
    bool socketConnect();
 
    void socketDisconnect();
 
    bool isSocketConnected() const;
 
    void sendData(DataInfoPtr dataPtr);
 
    unsigned connectionProperties() const;
 
    void applyInterPluginConfig(const QVariantMap& props);       
 
    using DataReceivedCallback = std::function<void (DataInfoPtr)>;
 
    template <typename TFunc>
    void setDataReceivedCallback(TFunc&& func)
    {
        m_dataReceivedCallback = std::forward<TFunc>(func);
    }
 
    using ErrorReportCallback = std::function<void (const QString& msg)>;
 
    template <typename TFunc>
    void setErrorReportCallback(TFunc&& func)
    {
        m_errorReportCallback = std::forward<TFunc>(func);
    }
 
    using ConnectionStatusReportCallback = std::function <void (bool)>;
 
    template <typename TFunc>
    void setConnectionStatusReportCallback(TFunc&& func)
    {
        m_connectionStatusReportCallback = std::forward<TFunc>(func);
    }  
 
    using InterPluginConfigReportCallback = std::function <void (const QVariantMap&)>;
 
    template <typename TFunc>
    void setInterPluginConfigReportCallback(TFunc&& func)
    {
        m_interPluginConfigReportCallback = std::forward<TFunc>(func);
    }  
 
    void setDebugOutputLevel(unsigned level = 0U);
 
protected:
    virtual bool startImpl();
 
    virtual void stopImpl();
 
    virtual bool socketConnectImpl();
 
    virtual void socketDisconnectImpl();
 
    virtual void sendDataImpl(DataInfoPtr dataPtr) = 0;
 
    virtual unsigned connectionPropertiesImpl() const;
 
    virtual void applyInterPluginConfigImpl(const QVariantMap& props);     
 
    void reportDataReceived(DataInfoPtr dataPtr);
 
    void reportError(const QString& msg);
 
    void reportDisconnected();
 
    void reportInterPluginConfig(const QVariantMap& props);
 
    static unsigned long long currTimestamp();
 
    unsigned getDebugOutputLevel() const;
 
private:
    DataReceivedCallback m_dataReceivedCallback;
    ErrorReportCallback m_errorReportCallback;
    ConnectionStatusReportCallback m_connectionStatusReportCallback;
    InterPluginConfigReportCallback m_interPluginConfigReportCallback;
 
    unsigned m_debugLevel = 0U;
    bool m_running = false;
    bool m_connected = false;
};
 
using SocketPtr = std::shared_ptr<Socket>;
 
}  // namespace cc_tools_qt