summaryrefslogtreecommitdiffstats
path: root/src/knx/netip/qknxnetiptunnelinginfodib.h
blob: 501ca44f115acd6470c79f3e9354a4f3dd51ef60 (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
/******************************************************************************
**
** 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 QKNXNETIPTUNNELINGINFODIB_H
#define QKNXNETIPTUNNELINGINFODIB_H

#include <QtCore/qshareddata.h>
#include <QtKnx/qknxaddress.h>
#include <QtKnx/qknxnetipstruct.h>

QT_BEGIN_NAMESPACE

class QKnxNetIpTunnelingSlotInfoPrivate;
class Q_KNX_EXPORT QKnxNetIpTunnelingSlotInfo final
{
    Q_GADGET

public:
    enum State : quint32
    {
        NotAvailable = 0x00000000,
        Free = 0x00000001,
        Authorized = 0x00000002,
        Usable = 0x00000004,
        Available = Free | Authorized | Usable,
        Invalid = 0xffffffff
    };
    Q_ENUM(State)
    Q_DECLARE_FLAGS(Status, State)

    QKnxNetIpTunnelingSlotInfo();
    ~QKnxNetIpTunnelingSlotInfo();

    explicit QKnxNetIpTunnelingSlotInfo(const QKnxAddress &ia);
    QKnxNetIpTunnelingSlotInfo(const QKnxAddress &is, QKnxNetIpTunnelingSlotInfo::Status status);

    bool isValid() const;

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

    QKnxNetIpTunnelingSlotInfo::Status status() const;
    void setStatus(QKnxNetIpTunnelingSlotInfo::Status status);

    QKnxByteArray bytes() const;
    static QKnxNetIpTunnelingSlotInfo fromBytes(const QKnxByteArray &data, quint16 index);

    QKnxNetIpTunnelingSlotInfo(const QKnxNetIpTunnelingSlotInfo &other);
    QKnxNetIpTunnelingSlotInfo &operator=(const QKnxNetIpTunnelingSlotInfo &other);

    void swap(QKnxNetIpTunnelingSlotInfo &other) Q_DECL_NOTHROW;

    QKnxNetIpTunnelingSlotInfo(QKnxNetIpTunnelingSlotInfo &&other) Q_DECL_NOTHROW;
    QKnxNetIpTunnelingSlotInfo &operator=(QKnxNetIpTunnelingSlotInfo &&other) Q_DECL_NOTHROW;

    bool operator==(const QKnxNetIpTunnelingSlotInfo &other) const;
    bool operator!=(const QKnxNetIpTunnelingSlotInfo &other) const;

private:
    QSharedDataPointer<QKnxNetIpTunnelingSlotInfoPrivate> d_ptr;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QKnxNetIpTunnelingSlotInfo::Status)

class QKnxNetIpTunnelingInfoDibPrivate;
class Q_KNX_EXPORT QKnxNetIpTunnelingInfoDibProxy final
{
public:
    QKnxNetIpTunnelingInfoDibProxy() = delete;
    ~QKnxNetIpTunnelingInfoDibProxy() = default;

    QKnxNetIpTunnelingInfoDibProxy(const QKnxNetIpDib &&) = delete;
    explicit QKnxNetIpTunnelingInfoDibProxy(const QKnxNetIpDib &dib);

    bool isValid() const;

    QKnxNetIp::DescriptionType descriptionType() const;

    quint16 maximumInterfaceApduLength() const;
    QKnxNetIpTunnelingSlotInfo tunnelingSlotInfo() const;
    QList<QKnxNetIpTunnelingSlotInfo> optionalSlotInfos() const;

    class Q_KNX_EXPORT Builder final
    {
    public:
        Builder();
        ~Builder();

        Builder &setMaximumInterfaceApduLength(quint16 length);
        Builder &setTunnelingSlotInfo(const QKnxNetIpTunnelingSlotInfo &info);
        Builder &setOptionalSlotInfos(const QList<QKnxNetIpTunnelingSlotInfo> &infos);

        QKnxNetIpDib create() const;

        Builder(const Builder &other);
        Builder &operator=(const Builder &other);

    private:
        QSharedDataPointer<QKnxNetIpTunnelingInfoDibPrivate> d_ptr;
    };
    static QKnxNetIpTunnelingInfoDibProxy::Builder builder();

private:
    const QKnxNetIpDib &m_dib;
};

QT_END_NAMESPACE

#endif