summaryrefslogtreecommitdiffstats
path: root/src/knx/netip/qknxnetiprouter_p.h
blob: a9809c73740003dafbe77666897b656a3d73be5d (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
/******************************************************************************
**
** Copyright (C) 2018 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 QKNXNETIPROUTER_P_H
#define QKNXNETIPROUTER_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 <QtCore/private/qobject_p.h>

#include <QtKnx/qknxnetip.h>
#include <QtKnx/qknxnetipframe.h>
#include <QtKnx/qknxnetiprouter.h>

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

QT_BEGIN_NAMESPACE

class QKnxNetIpRouterPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QKnxNetIpRouter)
public:
    QKnxNetIpRouterPrivate() = default;
    ~QKnxNetIpRouterPrivate() = default;

    void start();
    void restart();
    void stop();

    void cleanup();

    void processRoutingIndication(const QKnxNetIpFrame &frame);
    void processRoutingBusy(const QKnxNetIpFrame &frame);
    void processRoutingLostMessage(const QKnxNetIpFrame &frame);
    void processRoutingSystemBroadcast(const QKnxNetIpFrame &frame);

    bool sendFrame(const QKnxNetIpFrame &frame);

    void flowControlHandling(quint16 newBusyWaitTime);

    void changeState(QKnxNetIpRouter::State state);
    void errorOccurred(QKnxNetIpRouter::Error error, const QString &errorString);

    QKnxNetIpRouter::FilterAction filterAction(const QKnxLinkLayerFrame &frame);

    QUdpSocket *m_socket { nullptr };

    QKnxAddress m_individualAddress;

    quint16 m_framesReadCount;
    QKnxAddress m_lastIndicationAddress;
    quint16 m_sameKnxDstAddressIndicationCount;

    QNetworkInterface m_iface;
    QHostAddress m_multicastAddress { QLatin1String(QKnxNetIp::Constants::MulticastAddress) };
    quint16 m_multicastPort { QKnxNetIp::Constants::DefaultPort };
    QHostAddress m_ownAddress;

    QKnxNetIpRouter::State m_state { QKnxNetIpRouter::State::NotInit };

    quint16 m_busyWaitTime { QKnxNetIp::RoutingBusyWaitTime };
    QTimer *m_busyTimer { nullptr };

    enum class BusyTimerStage : quint8
    {
        NotInit,
        Wait,
        RandomWait,
        SlowDuration,
        DecrementBusyCounter
    };
    BusyTimerStage m_busyStage { BusyTimerStage::NotInit };
    quint32 m_busyCounter { 0 };

    QKnxNetIpRouter::Error m_error { QKnxNetIpRouter::Error::None };
    QString m_errorMessage;

    QKnxNetIpRouter::KnxAddressWhitelist m_filterTable;
    QKnxNetIpRouter::RoutingMode m_routingMode { QKnxNetIpRouter::RoutingMode::Block };
};

QT_END_NAMESPACE

#endif