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
|
/******************************************************************************
**
** 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_H
#define QKNXNETIPDISCOVERYAGENT_H
#include <QtCore/qobject.h>
#include <QtCore/qvector.h>
#include <QtKnx/qtknxglobal.h>
#include <QtKnx/qknxnetipserverinfo.h>
#include <QtNetwork/qhostaddress.h>
QT_BEGIN_NAMESPACE
class QKnxNetIpServerDiscoveryAgentPrivate;
class Q_KNX_EXPORT QKnxNetIpServerDiscoveryAgent final : public QObject
{
Q_OBJECT
Q_DISABLE_COPY(QKnxNetIpServerDiscoveryAgent)
Q_DECLARE_PRIVATE(QKnxNetIpServerDiscoveryAgent)
public:
enum class State : quint8
{
NotRunning,
Starting,
Running,
Stopping
};
Q_ENUM(State)
enum class Error : quint8
{
None,
Network,
NotIPv4,
Timeout,
Unknown = 0x80
};
Q_ENUM(Error)
enum class ResponseType : quint8
{
Unicast = 0x00,
Multicast = 0x01
};
Q_ENUM(ResponseType)
enum DiscoveryMode : quint8
{
CoreV1 = 0x01,
CoreV2 = 0x02
};
Q_ENUM(DiscoveryMode)
Q_DECLARE_FLAGS(DiscoveryModes, DiscoveryMode)
enum class InterfaceType : quint8
{
Loopback = 0x01,
Ethernet = 0x02,
Wifi = 0x04
};
Q_ENUM(InterfaceType)
Q_DECLARE_FLAGS(InterfaceTypes, InterfaceType)
QKnxNetIpServerDiscoveryAgent(QObject *parent = nullptr);
~QKnxNetIpServerDiscoveryAgent() override;
explicit QKnxNetIpServerDiscoveryAgent(const QHostAddress &localAddress,
QObject *parent = nullptr);
QKnxNetIpServerDiscoveryAgent(const QHostAddress &localAddress, quint16 localPort,
QObject *parent = nullptr);
QKnxNetIpServerDiscoveryAgent::State state() const;
QKnxNetIpServerDiscoveryAgent::Error error() const;
QString errorString() const;
QVector<QKnxNetIpServerInfo> discoveredServers() const;
quint16 localPort() const;
void setLocalPort(quint16 port);
QHostAddress localAddress() const;
void setLocalAddress(const QHostAddress &address);
int timeout() const;
void setTimeout(int msec);
int searchFrequency() const;
void setSearchFrequency(int timesPerMinute);
bool natAware() const;
void setNatAware(bool useNat);
quint8 multicastTtl() const;
void setMulticastTtl(quint8 ttl);
QKnxNetIpServerDiscoveryAgent::ResponseType responseType() const;
void setResponseType(QKnxNetIpServerDiscoveryAgent::ResponseType type);
QKnxNetIpServerDiscoveryAgent::DiscoveryModes discoveryMode() const;
void setDiscoveryMode(QKnxNetIpServerDiscoveryAgent::DiscoveryModes mode);
QVector<QKnxNetIpSrp> extendedSearchParameters() const;
void setExtendedSearchParameters(const QVector<QKnxNetIpSrp> &srps);
public Q_SLOTS:
void start();
void stop();
void start(int timeout);
void start(const QVector<QHostAddress> &localAddresses);
void start(QKnxNetIpServerDiscoveryAgent::InterfaceTypes types);
Q_SIGNALS:
void started();
void finished();
void deviceDiscovered(QKnxNetIpServerInfo server);
void stateChanged(QKnxNetIpServerDiscoveryAgent::State state);
void errorOccurred(QKnxNetIpServerDiscoveryAgent::Error error, QString errorString);
private:
QKnxNetIpServerDiscoveryAgent(QKnxNetIpServerDiscoveryAgentPrivate &dd, QObject *parent);
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QKnxNetIpServerDiscoveryAgent::DiscoveryModes)
Q_DECLARE_OPERATORS_FOR_FLAGS(QKnxNetIpServerDiscoveryAgent::InterfaceTypes)
QT_END_NAMESPACE
#endif
|
