clientmanager.h

/*
    SPDX-FileCopyrightText: 2012 Jasem Mutlaq <mutlaqja@ikarustech.com>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include <QPointer>
 
#ifdef USE_QT5_INDI
#include <baseclientqt.h>
#else
#include <baseclient.h>
#include <QObject>
#endif
 
#include "blobmanager.h"
 
class DeviceInfo;
class DriverInfo;
class ServerManager;
 
/**
 * @class ClientManager
 * ClientManager manages connection to INDI server, creation of devices, and receiving/sending properties.
 *
 * ClientManager is a subclass of INDI::BaseClient class part of the INDI Library.
 * This enables the class to communicate with INDI server and to receive notification of devices, properties, and messages.
 *
 * @author Jasem Mutlaq
 * @version 1.3
 */
#ifdef USE_QT5_INDI
class ClientManager : public INDI::BaseClientQt
#else
class ClientManager : public QObject, public INDI::BaseClient
#endif
{
        Q_OBJECT
 
    public:
        ClientManager();
        virtual ~ClientManager() = default;
 
        /**
         * @brief appendManagedDriver Add driver to pool of managed drivers by this client manager.
         * @param dv pointer to driver info instance.
         * @note This function is ALWAYS called from the main KStars thread.
         */
        void appendManagedDriver(const QSharedPointer<DriverInfo> &driver);
 
        /**
         * @brief removeManagedDriver Remove managed driver from pool of drivers managed by this client manager.
         * @param dv pointer to driver info instance.
         * @note This function is ALWAYS called from the main KStars thread.
         */
        void removeManagedDriver(const QSharedPointer<DriverInfo> &driver);
 
        /**
         * @brief disconnectAll Disconnect from server and disconnect all BLOB Managers.
         */
        void disconnectAll();
 
        int count()
        {
            return m_ManagedDrivers.count();
        }
 
        bool isBLOBEnabled(const QString &device, const QString &property);
        void setBLOBEnabled(bool enabled, const QString &device, const QString &property);
 
        ServerManager *getServerManager()
        {
            return sManager;
        }
 
        const QSharedPointer<DriverInfo> &findDriverInfoByName(const QString &name);
        const QSharedPointer<DriverInfo> &findDriverInfoByLabel(const QString &label);
 
        bool isDriverManaged(const QSharedPointer<DriverInfo> &driver);
 
        const QList<QSharedPointer<DriverInfo>> &getManagedDrivers() const;
 
        void establishConnection();
 
    protected:
        virtual void newDevice(INDI::BaseDevice dp) override;
        virtual void removeDevice(INDI::BaseDevice dp) override;
 
        virtual void newProperty(INDI::Property prop) override;
        virtual void updateProperty(INDI::Property prop) override;
        virtual void removeProperty(INDI::Property prop) override;
 
        virtual void newMessage(INDI::BaseDevice dp, int messageID) override;
        virtual void newUniversalMessage(std::string message) override;
 
        virtual void serverConnected() override;
        virtual void serverDisconnected(int exitCode) override;
 
    private:
        void processNewProperty(INDI::Property prop);
        void processRemoveBLOBManager(const QString &device, const QString &property);
        QList<QSharedPointer<DriverInfo>> m_ManagedDrivers;
        QList<BlobManager *> blobManagers;
        ServerManager *sManager { nullptr };
 
    signals:
        // Client successfully connected to the server.
        void started();
        // Client failed to connect to the server.
        void failed(const QString &message);
        // Running client was abnormally disconnected from server.
        void terminated(const QString &message);
 
        // @note If using INDI Posix client, the following newINDIDevice/Property and removeINDIDevice/Property signals
        // must be connected to slots using Qt::BlockingQueuedConnection to ensure operation is fully completed before
        // resuming the INDI client thread. For Qt Based INDI client, Qt::DirectConnection should be used.
 
        void newINDIDevice(DeviceInfo *dv);
        void removeINDIDevice(const QString &name);
 
        void newINDIProperty(INDI::Property prop);
        void updateINDIProperty(INDI::Property prop);
        void removeINDIProperty(INDI::Property prop);
 
        void newBLOBManager(const char *device, INDI::Property prop);
        void removeBLOBManager(const QString &device, const QString &property);
 
        void newINDIMessage(INDI::BaseDevice dp, int messageID);
        void newINDIUniversalMessage(const QString &message);
 
    private:
        static constexpr uint8_t MAX_RETRIES {2};
        uint8_t m_ConnectionRetries {MAX_RETRIES};
        bool m_PendingConnection {false};
};