Differential D17185 Diff 46387 src/settings/iptunnelsetting.h

Changeset View

Standalone View

View Options

src/settings/iptunnelsetting.h

  • This file was added.
1​/*
2​ Copyright 2018 Pranav Gade <pranavgade20@gmail.com>
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Lesser General Public
6​ License as published by the Free Software Foundation; either
7​ version 2.1 of the License, or (at your option) version 3, or any
8​ later version accepted by the membership of KDE e.V. (or its
9​ successor approved by the membership of KDE e.V.), which shall
10​ act as a proxy defined in Section 6 of version 3 of the license.
11​
12​ This library is distributed in the hope that it will be useful,
13​ but WITHOUT ANY WARRANTY; without even the implied warranty of
14​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​ Lesser General Public License for more details.
16​
17​ You should have received a copy of the GNU Lesser General Public
18​ License along with this library. If not, see <http://www.gnu.org/licenses/>.
19​*/
20​
21​#ifndef NETWORKMANAGERQT_IPTUNNEL_SETTING_H
22​#define NETWORKMANAGERQT_IPTUNNEL_SETTING_H
23​
24​#include <networkmanagerqt/networkmanagerqt_export.h>
25​#include "setting.h"
26​
27​#include <QString>
28​
29​// #if NM_CHECK_VERSION(1, 12, 0)
jgrulichUnsubmitted
Done

This shouldn't be commented out.

jgrulich: This shouldn't be commented out.
30​#define NM_SETTING_IP_TUNNEL_FLAGS "flags"
jgrulichUnsubmitted
Done

There is no reason to create your own defines, use just those NM_SETTING_IP_TUNNEL_PROPERTY_NAME.

jgrulich: There is no reason to create your own defines, use just those…
jgrulichUnsubmitted
Done

This should be actually !NM_CHECK_VERSION(1, 12 0), because we want to define it for NM < 1.12.0. Sorry I didn't spot this before.

jgrulich: This should be actually !NM_CHECK_VERSION(1, 12 0), because we want to define it for NM < 1.12.
31​// #endif
32​
33​namespace NetworkManager
34​{
35​
36​class IpTunnelSettingPrivate;
37​
38​/**
39​ * Represents generic setting
40​ */
41​class NETWORKMANAGERQT_EXPORT IpTunnelSetting : public Setting
42​{
43​public:
44​ typedef QSharedPointer<IpTunnelSetting> Ptr;
45​ typedef QList<Ptr> List;
46​ enum Mode { DefaultMode, Ipip, Gre, Sit, Isatap, Vti, Ip6ip6, Ipip6, Ip6gre, Vti6 };
jgrulichUnsubmitted
Done

There is no default mode, the first one should be Unknown. Also you maybe want to assign values to them?

Like:

enum Mode {

Unknown = NM_IP_TUNNEL_MODE_UNKNOWN,
Ipip = NM_IP_TUNNEL_MODE_IPIP
etc.

}

jgrulich: There is no default mode, the first one should be Unknown. Also you maybe want to assign values…
47​ enum Flag {None = 0, EncapLimit = 0x1, OrigTclass = 0x2, OrigFlowlabel = 0x4, Mip6Dev = 0x8, DscpCopy = 0x10, OrigFwmark = 0x20};
jgrulichUnsubmitted
Done

The flags don't seem to use full name. For example NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT should perhabs be IgnEncapLimit.

jgrulich: The flags don't seem to use full name. For example NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT should…
jgrulichUnsubmitted
Done

The change you did for flags was meant to be for Mode enum. The first flag is None, that was correct.

jgrulich: The change you did for flags was meant to be for Mode enum. The first flag is None, that was…
48​ Q_DECLARE_FLAGS(Flags, Flag)
49​
50​ IpTunnelSetting();
51​ explicit IpTunnelSetting(const Ptr &other);
52​ ~IpTunnelSetting() override;
53​
54​ QString name() const override;
55​
56​ void setMode(Mode mode);
57​ Mode mode() const;
58​
jgrulichUnsubmitted
Done

There are other modes, they are just not documented in the documentation, but can be found in the source code.

See:
typedef enum {
NM_IP_TUNNEL_MODE_UNKNOWN = 0,
NM_IP_TUNNEL_MODE_IPIP = 1,
NM_IP_TUNNEL_MODE_GRE = 2,
NM_IP_TUNNEL_MODE_SIT = 3,
NM_IP_TUNNEL_MODE_ISATAP = 4,
NM_IP_TUNNEL_MODE_VTI = 5,
NM_IP_TUNNEL_MODE_IP6IP6 = 6,
NM_IP_TUNNEL_MODE_IPIP6 = 7,
NM_IP_TUNNEL_MODE_IP6GRE = 8,
NM_IP_TUNNEL_MODE_VTI6 = 9,
} NMIPTunnelMode;

jgrulich: There are other modes, they are just not documented in the documentation, but can be found in…
59​ void setPathMtuDiscovery(bool discovery);
60​ bool pathMtuDiscovery() const;
jgrulichUnsubmitted
Done

Turn this into QFlags. You can check how this should be done for example in VlanSetting

jgrulich: Turn this into QFlags. You can check how this should be done for example in VlanSetting
61​
62​ void setEncapsulationLimit(quint32 limit);
63​ quint32 encapsulationLimit() const;
64​
65​ void setFlags(Flags flags);
66​ Flags flags() const;
67​
68​ void setFlowLabel(quint32 label);
69​ quint32 flowLabel() const;
70​
71​ void setMtu(quint32 mtu);
72​ quint32 mtu() const;
73​
74​ void setTos(quint32 tos);
75​ quint32 tos() const;
jgrulichUnsubmitted
Done

Maybe turn this into QFlags?

See:
typedef enum { /*< flags, prefix=NM_IP_TUNNEL_FLAG >*/
NM_IP_TUNNEL_FLAG_NONE = 0x0,
NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT = 0x1,
NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS = 0x2,
NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL = 0x4,
NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV = 0x8,
NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY = 0x10,
NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK = 0x20,
} NMIPTunnelFlags;

jgrulich: Maybe turn this into QFlags? See: typedef enum { /*< flags, prefix=NM_IP_TUNNEL_FLAG >*/…
pranavgadeAuthorUnsubmitted
Done

What do you mean? Should I create a new Enum?

pranavgade: What do you mean? Should I create a new Enum?
jgrulichUnsubmitted
Done

Check QFlags, it's similar to enum, but you can combine them.

jgrulich: Check QFlags, it's similar to enum, but you can combine them.
jgrulichUnsubmitted
Done

Coding style. It should be setFoo(const QString &foo), the '&' should be separated from QString by a space and not separated by a space from "key". Same for other methods below.

jgrulich: Coding style. It should be setFoo(const QString &foo), the '&' should be separated from QString…
76​
77​ void setTtl(quint32 ttl);
78​ quint32 ttl() const;
79​
80​ void setInputKey(const QString &key);
81​ QString inputKey() const;
82​
83​ void setLocal(const QString &local);
84​ QString local() const;
85​
86​ void setParent(const QString &parent);
87​ QString parent() const;
88​
89​ void setOutputKey(const QString &key);
90​ QString outputKey() const;
91​
92​ void setRemote(const QString &remote);
93​ QString remote() const;
94​
95​ void fromMap(const QVariantMap &setting) override;
96​
97​ QVariantMap toMap() const override;
98​
99​protected:
100​ IpTunnelSettingPrivate *d_ptr;
101​
102​private:
103​ Q_DECLARE_PRIVATE(IpTunnelSetting)
104​};
105​Q_DECLARE_OPERATORS_FOR_FLAGS(IpTunnelSetting::Flags)
106​
107​NETWORKMANAGERQT_EXPORT QDebug operator<<(QDebug dbg, const IpTunnelSetting &setting);
108​
109​}
110​
111​#endif // NETWORKMANAGERQT_IP_TUNNEL_SETTING_H
112​