connectiontcp.h

Go to the documentation of this file.

/*******************************************************************************
  Copyright(c) 2017 Jasem Mutlaq. All rights reserved.
 
 Connection Plugin Interface
 
 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 "connectioninterface.h"
#include "indipropertytext.h"
#include "indipropertyswitch.h"
 
#include <stdint.h>
#include <cstdlib>
#include <string>
 
namespace Connection
{
class TCP : public Interface
{
    public:
        enum ConnectionType
        {
            TYPE_TCP = 0,
            TYPE_UDP
        };
 
        TCP(INDI::DefaultDevice *dev, IPerm permission = IP_RW);
        virtual ~TCP() = default;
 
        virtual bool Connect() override;
 
        virtual bool Disconnect() override;
 
        virtual void Activated() override;
 
        virtual void Deactivated() override;
 
        virtual std::string name() override
        {
            return "CONNECTION_TCP";
        }
 
        virtual std::string label() override
        {
            return "Network";
        }
 
        virtual const char *host() const
        {
            return AddressTP[0].getText();
        }
        virtual uint32_t port() const
        {
            return atoi(AddressTP[1].getText());
        }
        ConnectionType connectionType() const
        {
            return static_cast<ConnectionType>(TcpUdpSP.findOnSwitchIndex());
        }
 
        virtual bool ISNewText(const char *dev, const char *name, char *texts[], char *names[], int n) override;
        virtual bool ISNewSwitch(const char *dev, const char *name, ISState *states, char *names[], int n) override;
        virtual bool saveConfigItems(FILE *fp) override;
 
        int getPortFD() const
        {
            return PortFD;
        }
        void setDefaultHost(const char *addressHost);
        void setDefaultPort(uint32_t addressPort);
        void setConnectionType(int type);
        void setLANSearchEnabled(bool enabled);
 
    protected:
        bool establishConnection(const std::string &hostname, const std::string &port, int timeout = -1);
 
        // IP Address/Port
        INDI::PropertyText AddressTP {2};
        // Connection Type
        INDI::PropertySwitch TcpUdpSP {2};
        // Auto search
        INDI::PropertySwitch LANSearchSP {2};
 
        // Variables
        IPerm m_Permission = IP_RW;
        std::string m_ConfigHost;
        std::string m_ConfigPort;
        int m_ConfigConnectionType {-1};
        int m_SockFD {-1};
        int PortFD = -1;
        static constexpr uint8_t SOCKET_TIMEOUT {5};
};
}