summaryrefslogtreecommitdiffstats
path: root/src/knx/netip/qknxnetipendpointconnection.h
blob: 4c94b78c4bf80c43a1ba9c178e1dbd88c0fcb7bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/******************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtKnx module.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
******************************************************************************/

#ifndef QKNXNETIPENDPOINTCONNECTION_H
#define QKNXNETIPENDPOINTCONNECTION_H

#include <QtKnx/qtknxglobal.h>
#include <QtKnx/qknxnetipcri.h>
#include <QtKnx/qknxnetipframe.h>
#include <QtKnx/qknxnetiphpai.h>
#include <QtKnx/qknxnetipsecureconfiguration.h>

#include <QtNetwork/qudpsocket.h>

QT_BEGIN_NAMESPACE

class QKnxNetIpEndpointConnectionPrivate;
class Q_KNX_EXPORT QKnxNetIpEndpointConnection : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY(QKnxNetIpEndpointConnection)
    Q_DECLARE_PRIVATE(QKnxNetIpEndpointConnection)

public:
    enum State : quint8
    {
        Disconnected,
        Starting,
        Bound,
        Connecting,
        Connected,
        Disconnecting
    };
    Q_ENUM(State)
    QKnxNetIpEndpointConnection::State state() const;

    enum class Error : quint8
    {
        None,
        State,
        Network,
        NotIPv4,
        Acknowledge,
        Heartbeat,
        Cemi,
        SecureConfig,
        SerialNumber,
        AuthFailed,
        Timeout,
        Close,
        Unknown = 0x80
    };
    Q_ENUM(Error)

    QString errorString() const;
    QKnxNetIpEndpointConnection::Error error() const;

    enum SequenceType : quint8
    {
        Send,
        Receive,
    };
    Q_ENUM(SequenceType)
    int sequenceCount(SequenceType type) const;

    enum class EndpointType : quint8
    {
        Data,
        Control
    };
    quint8 netIpHeaderVersion(EndpointType endpoint) const;

    QKnxNetIpEndpointConnection() = delete;
    virtual ~QKnxNetIpEndpointConnection() = 0;

    quint16 localPort() const;
    void setLocalPort(quint16 port);

    QHostAddress localAddress() const;
    void setLocalAddress(const QHostAddress &address);

    bool natAware() const;
    void setNatAware(bool isAware);

    quint32 heartbeatTimeout() const;
    void setHeartbeatTimeout(quint32 msec);

    QKnxByteArray supportedProtocolVersions() const;
    void setSupportedProtocolVersions(const QKnxByteArray &versions);

    void connectToHost(const QKnxNetIpHpai &controlEndpoint);
    void connectToHost(const QHostAddress &address, quint16 port);
    void connectToHost(const QHostAddress &address, quint16 port, QKnxNetIp::HostProtocol proto);

    QKnxByteArray serialNumber() const;
    void setSerialNumber(const QKnxByteArray &serialNumber);

    QKnxNetIpSecureConfiguration secureConfiguration() const;
    void setSecureConfiguration(const QKnxNetIpSecureConfiguration &config);

    void connectToHostEncrypted(const QKnxNetIpHpai &controlEndpoint);
    void connectToHostEncrypted(const QHostAddress &address, quint16 port);

    void disconnectFromHost();

protected:
    QKnxNetIpEndpointConnection(QKnxNetIpEndpointConnectionPrivate &dd, QObject *parent);

Q_SIGNALS:
    void connected();
    void disconnected();

    void stateChanged(QKnxNetIpEndpointConnection::State state);
    void errorOccurred(QKnxNetIpEndpointConnection::Error error, QString errorString);
};

QT_END_NAMESPACE

#endif