ToolsSocket.h

//
// Copyright 2014 - 2026 (C). Alex Robenko. All rights reserved.
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
 
// 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 "cc_tools_qt/ToolsApi.h"
#include "cc_tools_qt/ToolsDataInfo.h"
#include "cc_tools_qt/version.h"
 
#include <QtCore/QObject>
#include <QtCore/QString>
 
#include <cstdint>
#include <cstddef>
#include <memory>
#include <vector>
 
namespace cc_tools_qt
{
 
class CC_TOOLS_API ToolsSocket : public QObject
{
    Q_OBJECT
public:
    enum ConnectionProperty
    {
        ConnectionProperty_Autoconnect = 0x1, 
        ConnectionProperty_NonDisconnectable = 0x2 
    };
 
    ToolsSocket();
 
    virtual ~ToolsSocket() noexcept;
 
    bool start();
 
    void stop();
 
    bool isRunning() const;
 
    bool socketConnect();
 
    void socketDisconnect();
 
    bool isSocketConnected() const;
 
    void sendData(ToolsDataInfoPtr dataPtr);
 
    unsigned connectionProperties() const;
 
    void applyInterPluginConfig(const QVariantMap& props);
 
    void setDebugOutputLevel(unsigned level = 0U);
 
signals:
    void sigDataReceivedReport(ToolsDataInfoPtr data);
 
    void sigErrorReport(const QString& msg);
 
    void sigConnectionStatusReport(bool connected);
 
    void sigInterPluginConfigReport(const QVariantMap& props);
 
protected:
    virtual bool startImpl();
 
    virtual void stopImpl();
 
    virtual bool socketConnectImpl();
 
    virtual void socketDisconnectImpl();
 
    virtual void sendDataImpl(ToolsDataInfoPtr dataPtr) = 0;
 
    virtual unsigned connectionPropertiesImpl() const;
 
    virtual void applyInterPluginConfigImpl(const QVariantMap& props);
 
    static unsigned long long currTimestamp();
 
    unsigned getDebugOutputLevel() const;
 
protected slots:
    void reportDataReceived(ToolsDataInfoPtr dataPtr);
 
    void reportError(const QString& msg);
 
    void reportDisconnected();
 
    void reportInterPluginConfig(const QVariantMap& props);
 
private:
    struct InnerState;
    std::unique_ptr<InnerState> m_state;
};
 
using ToolsSocketPtr = std::shared_ptr<ToolsSocket>;
 
}  // namespace cc_tools_qt