Filter.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 <QtCore/QList>
 
#include "DataInfo.h"
#include "Api.h"
 
namespace cc_tools_qt
{
 
class CC_API Filter
{
public:
    Filter();
 
    virtual ~Filter() noexcept;
 
    bool start();
 
    void stop();
 
    QList<DataInfoPtr> recvData(DataInfoPtr dataPtr);
 
    QList<DataInfoPtr> sendData(DataInfoPtr dataPtr);
 
    void socketConnectionReport(bool connected);
 
    void applyInterPluginConfig(const QVariantMap& props);     
 
    using DataToSendCallback = std::function<void (DataInfoPtr)>;
 
    template <typename TFunc>
    void setDataToSendCallback(TFunc&& func)
    {
        m_dataToSendCallback = 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 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 QList<DataInfoPtr> recvDataImpl(DataInfoPtr dataPtr);
 
    virtual QList<DataInfoPtr> sendDataImpl(DataInfoPtr dataPtr);
 
    virtual void socketConnectionReportImpl(bool connected);
 
    virtual void applyInterPluginConfigImpl(const QVariantMap& props);      
 
    virtual const char* debugNameImpl() const;
 
    void reportDataToSend(DataInfoPtr dataPtr);
 
    void reportError(const QString& msg);
 
    void reportInterPluginConfig(const QVariantMap& props);    
 
    static unsigned long long currTimestamp();
 
    unsigned getDebugOutputLevel() const;
 
private:
    DataToSendCallback m_dataToSendCallback;
    ErrorReportCallback m_errorReportCallback;
    InterPluginConfigReportCallback m_interPluginConfigReportCallback;
    unsigned m_debugLevel = 0U;
};
 
using FilterPtr = std::shared_ptr<Filter>;
 
}  // namespace cc_tools_qt