summaryrefslogtreecommitdiffstats
path: root/src/knx/netip/qknxnetipserverdiscoveryagent_p.h
blob: 46be5fecc2ff1730cc14760eecb1342c6610c68f (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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/******************************************************************************
**
** 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 QKNXNETIPDISCOVERYAGENT_P_H
#define QKNXNETIPDISCOVERYAGENT_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt KNX API.  It exists for the convenience
// of the Qt KNX implementation.  This header file may change from version
// to version without notice, or even be removed.
//
// We mean it.
//

#include <QtCore/qtimer.h>
#include <QtKnx/qtknxglobal.h>
#include <QtKnx/qknxnetip.h>
#include <QtKnx/qknxnetipsearchrequest.h>
#include <QtKnx/qknxnetipsearchresponse.h>
#include <QtKnx/qknxnetipserverdiscoveryagent.h>

#include <QtNetwork/qhostaddress.h>
#include <QtNetwork/qnetworkdatagram.h>
#include <QtNetwork/qnetworkinterface.h>
#include <QtNetwork/qudpsocket.h>

#include <private/qobject_p.h>

QT_BEGIN_NAMESPACE

struct Adapter
{
    QHostAddress address;
    QNetworkInterface iface;
};

struct DiscovererConfig
{
    DiscovererConfig() = default;
    ~DiscovererConfig() = default;

    DiscovererConfig(int ttl, int timeout, bool nat, bool multicast, bool coreV1, bool coreV2,
            const QVector<QKnxNetIpSrp> &srps)
        : Ttl(ttl)
        , Timeout(timeout)
        , Nat(nat)
        , Multicast(multicast)
        , DiscoveryCoreV1(coreV1)
        , DiscoveryCoreV2(coreV2)
        , ExtendedSearchParameters(srps)
    {}

    int Ttl { 64 };
    int Timeout { 3000 };

    bool Nat { false };
    bool Multicast { true };

    bool DiscoveryCoreV1 { true };
    bool DiscoveryCoreV2 { true };

    QVector<QKnxNetIpSrp> ExtendedSearchParameters;
};

class Discoverer : public QObject
{
    Q_OBJECT

public:
    Discoverer(const QHostAddress &address, const QNetworkInterface iface, const DiscovererConfig &config);
    ~Discoverer() override;

public slots:
    void start();
    void finish();

signals:
    void started();
    void timeout();
    void finished(Discoverer *iam);

    void stateChanged(QKnxNetIpServerDiscoveryAgent::State state);
    void errorOccurred(QKnxNetIpServerDiscoveryAgent::Error error, const QString &errorString);

    void deviceDiscovered(const QKnxNetIpServerInfo &discoveryInfo);

private slots:
    void onTimeout();
    void onReadyRead();
    void onError(QUdpSocket::SocketError error);

private:
    void setAndEmitStateChanged(QKnxNetIpServerDiscoveryAgent::State state);

private:
    QHostAddress m_address;
    QNetworkInterface m_iface;

    QTimer *m_timer { nullptr };
    QUdpSocket *m_socket { nullptr };

    DiscovererConfig m_config;
    QVector<QByteArray> m_devices;

    QHostAddress m_multicast { QStringLiteral("224.0.23.12") };
    QKnxNetIpServerDiscoveryAgent::State m_state { QKnxNetIpServerDiscoveryAgent::State::NotRunning };
};

class Q_KNX_EXPORT QKnxNetIpServerDiscoveryAgentPrivate final : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QKnxNetIpServerDiscoveryAgent)

public:
    QKnxNetIpServerDiscoveryAgentPrivate(const QHostAddress &addr, quint16 prt);
    ~QKnxNetIpServerDiscoveryAgentPrivate() override = default;

    void setupSocket();

    void setupAndStartReceiveTimer();
    void setupAndStartFrequencyTimer();

    void setAndEmitStateChanged(QKnxNetIpServerDiscoveryAgent::State newState);
    void setAndEmitDeviceDiscovered(const QKnxNetIpServerInfo &discoveryInfo);
    void setAndEmitErrorOccurred(QKnxNetIpServerDiscoveryAgent::Error newError, const QString &message);

    void start();
    void start(const QVector<Adapter> &adapters);
    void start(const QVector<QHostAddress> addresses);
    void start(QKnxNetIpServerDiscoveryAgent::InterfaceTypes types);
    void stop();

private:
    QUdpSocket *socket { nullptr };
    QTimer *receiveTimer { nullptr };
    QTimer *frequencyTimer { nullptr };

    quint16 port { 0 }, usedPort { 0 };
    QHostAddress address { QHostAddress::Null }, usedAddress;

    const quint16 multicastPort { QKnxNetIp::Constants::DefaultPort };
    const QHostAddress multicastAddress { QLatin1String(QKnxNetIp::Constants::MulticastAddress) };

    quint8 ttl { 64 };
    bool nat { false };
    int frequency { 0 };
    int timeout { QKnxNetIp::Timeout::SearchTimeout };

    QString errorString;
    QVector<QKnxNetIpServerInfo> servers;

    QKnxNetIpServerDiscoveryAgent::Error error { QKnxNetIpServerDiscoveryAgent::Error::None };
    QKnxNetIpServerDiscoveryAgent::State state { QKnxNetIpServerDiscoveryAgent::State::NotRunning };
    QKnxNetIpServerDiscoveryAgent::ResponseType
        type { QKnxNetIpServerDiscoveryAgent::ResponseType::Multicast };

    QKnxNetIpServerDiscoveryAgent::DiscoveryModes mode
        { QKnxNetIpServerDiscoveryAgent::DiscoveryMode::CoreV1 };
    QVector<QKnxNetIpSrp> srps;

    Adapter adapter;
    QVector<Discoverer*> discoveries;
};

QT_END_NAMESPACE

#endif