summaryrefslogtreecommitdiffstats
path: root/src/knx/netip/qknxnetiproutinginterface.h
blob: 39560f623adbef0cbade4dcc69890e8c22f799e9 (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
/******************************************************************************
**
** 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 QKNXNETIPROUTINGINTERFACE_H
#define QKNXNETIPROUTINGINTERFACE_H

#include <QtKnx/qknxaddress.h>
#include <QtKnx/qknxnetipframe.h>
#include <QtKnx/qknxlinklayerframe.h>
#include <QtKnx/qtknxglobal.h>

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

QT_BEGIN_NAMESPACE

class QKnxNetIpRoutingInterfacePrivate;
class Q_KNX_EXPORT QKnxNetIpRoutingInterface : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY(QKnxNetIpRoutingInterface)
    Q_DECLARE_PRIVATE(QKnxNetIpRoutingInterface)

public:
    using FilterTable = QSet<QKnxAddress>;

    enum class State : quint8
    {
        NotInit,
        Routing,
        NeighborBusy,
        Stop,
        Failure
    };
    Q_ENUM(State)
    QKnxNetIpRoutingInterface::State state() const;

    enum class Error : quint8
    {
        None,
        KnxRouting,
        Network
    };
    Q_ENUM(Error)

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

    enum class FilterAction : quint8
    {
        RouteUnmodified,
        RouteDecremented,
        RouteLast,
        ForwardLocally,
        IgnoreTotally,
        IgnoreAcked
    };
    Q_ENUM(FilterAction)

    enum class RoutingMode : quint8
    {
        BlockRouting,
        RouteAll,
        FilterTableRouting
    };

    QKnxNetIpRoutingInterface(QObject *parent = nullptr);
    ~QKnxNetIpRoutingInterface() = default;

    RoutingMode routingMode() const;
    void setRoutingMode(RoutingMode mode);

    FilterTable filterTable() const;
    void setFilterTable(const FilterTable &table);

    QNetworkInterface interfaceAffinity() const;
    void setInterfaceAffinity(const QHostAddress &address);
    void setInterfaceAffinity(const QNetworkInterface &iface);

    QHostAddress multicastAddress() const;
    void setMulticastAddress(const QHostAddress &address);

    QKnxAddress individualAddress() const;
    void setIndividualAddress(const QKnxAddress &address);

public Q_SLOTS:
    void sendRoutingIndication(const QKnxLinkLayerFrame &linkFrame);
    void sendRoutingIndication(const QKnxNetIpFrame &frame);
    void sendRoutingBusy(const QKnxNetIpFrame &frame);
    void sendRoutingLostMessage(const QKnxNetIpFrame &frame);

    void start();
    void stop();

Q_SIGNALS:
    void routingIndicationSent(QKnxNetIpFrame frame);
    void routingBusySent(QKnxNetIpFrame frame);
    void routingLostCountSent(QKnxNetIpFrame frame);

    void routingIndicationReceived(QKnxNetIpFrame frame, QKnxNetIpRoutingInterface::FilterAction action);
    void routingBusyReceived(QKnxNetIpFrame frame);
    void routingLostCountReceived(QKnxNetIpFrame frame);

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

QT_END_NAMESPACE

#endif