File indexing completed on 2024-05-12 05:53:14

0001 /*
0002  * Copyright 2020 Kitae Kim <develoot@gmail.com>
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Lesser General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2.1 of the License, or (at your option) version 3, or any
0008  * later version accepted by the membership of KDE e.V. (or its
0009  * successor approved by the membership of KDE e.V.), which shall
0010  * act as a proxy defined in Section 6 of version 3 of the license.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General Public
0018  * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
0019  */
0020 
0021 #pragma once
0022 
0023 #include "connectionconfiguration.h"
0024 
0025 #include <QObject>
0026 
0027 #include "kirogicore_export.h"
0028 
0029 namespace Kirogi
0030 {
0031 /**
0032  * An abstract class of UDP, TCP and Serial connections.
0033  *
0034  * Plugin authors have to inherit this class to implement their own connection class.
0035  */
0036 class KIROGI_EXPORT AbstractConnection : public QObject
0037 {
0038     Q_OBJECT
0039 
0040     Q_PROPERTY(ConnectionConfiguration *configuration READ configuration CONSTANT)
0041     Q_PROPERTY(State state READ state NOTIFY stateChanged)
0042 
0043 public:
0044     enum class State { Disconnected, Connected };
0045     Q_ENUM(State);
0046 
0047     AbstractConnection(QObject *parent = nullptr);
0048     ~AbstractConnection();
0049 
0050     virtual bool connect() = 0;
0051     virtual bool disconnect() = 0;
0052 
0053     virtual ConnectionConfiguration *configuration() = 0;
0054 
0055     State state() const;
0056 
0057 Q_SIGNALS:
0058     void stateChanged();
0059 
0060 public Q_SLOTS:
0061     virtual void sendBytes(const QByteArray &bytes) = 0;
0062 
0063 protected:
0064     void setState(State state);
0065 
0066 private:
0067     State m_state;
0068 };
0069 }