abstractbaseclient.h

Go to the documentation of this file.

/*******************************************************************************
  Copyright(c) 2016 Jasem Mutlaq. All rights reserved.
  Copyright(c) 2022 Pawel Soja <[email protected]>
 
 INDI Qt Client
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Library General Public
 License version 2 as published by the Free Software Foundation.
 
 This library 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
 Library General Public License for more details.
 
 You should have received a copy of the GNU Library General Public License
 along with this library; see the file COPYING.LIB.  If not, write to
 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 Boston, MA 02110-1301, USA.
*******************************************************************************/
 
#pragma once
 
#include "indibase.h"
#include "indimacros.h"
#include "indiproperty.h"
 
#include <cstdint>
#include <memory>
#include <vector>
#include <functional>
 
namespace INDI
{
 
class BaseDevice;
class AbstractBaseClientPrivate;
class AbstractBaseClient : public INDI::BaseMediator
{
        DECLARE_PRIVATE_D(d_ptr_indi, AbstractBaseClient)
 
    public:
        AbstractBaseClient() = delete;
        virtual ~AbstractBaseClient();
 
    public:
        void setServer(const char *hostname, unsigned int port);
 
        const char *getHost() const;
 
        int getPort() const;
 
    public:
        virtual bool connectServer() = 0;
 
        virtual bool disconnectServer(int exit_code = 0) = 0;
 
        bool isServerConnected() const;
 
        void setConnectionTimeout(uint32_t seconds, uint32_t microseconds);
 
    public:
        void setVerbose(bool enable);
 
        bool isVerbose() const;
 
    public:
        void watchDevice(const char *deviceName);
        void watchDevice(const char *deviceName, const std::function<void (BaseDevice)> &callback);
 
        void watchProperty(const char *deviceName, const char *propertyName);
 
    public:
        void connectDevice(const char *deviceName);
 
        void disconnectDevice(const char *deviceName);
 
    public:
        INDI::BaseDevice getDevice(const char *deviceName);
 
        std::vector<INDI::BaseDevice> getDevices() const;
 
        bool getDevices(std::vector<INDI::BaseDevice> &deviceList, uint16_t driverInterface);
 
    public:
        void setBLOBMode(BLOBHandling blobH, const char *dev, const char *prop = nullptr);
 
        BLOBHandling getBLOBMode(const char *dev, const char *prop = nullptr);
 
    public:
        void sendNewProperty(INDI::Property pp);
 
        void sendNewText(INDI::Property pp);
        void sendNewText(const char *deviceName, const char *propertyName, const char *elementName, const char *text);
        void sendNewNumber(INDI::Property pp);
        void sendNewNumber(const char *deviceName, const char *propertyName, const char *elementName, double value);
        void sendNewSwitch(INDI::Property pp);
        void sendNewSwitch(const char *deviceName, const char *propertyName, const char *elementName);
 
        void startBlob(const char *devName, const char *propName, const char *timestamp);
        void sendOneBlob(IBLOB *bp);
        void sendOneBlob(INDI::WidgetViewBlob *blob);
        void sendOneBlob(const char *blobName, unsigned int blobSize, const char *blobFormat, void *blobBuffer);
        void finishBlob();
 
    public:
        void sendPingRequest(const char * uid);
 
        void sendPingReply(const char * uid);
 
    protected:
        virtual void newPingReply(std::string uid);
 
    protected:
        virtual void newUniversalMessage(std::string message);
 
    protected:
        friend class BaseClientPrivate;
        friend class BaseClientQtPrivate;
 
    protected:
        AbstractBaseClient(std::unique_ptr<AbstractBaseClientPrivate> &&dd);
 
    protected:
        std::unique_ptr<AbstractBaseClientPrivate> d_ptr_indi;
};
 
}
 
#ifdef SWIG
%template(BaseDeviceVectorShared) std::vector<INDI::BaseDevice>;
#endif