Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

NetworkManager::IpTunnelDevice Class

A Ip Tunnel device interface. More...

• Header: #include <NetworkManagerQt/IpTunnelDevice>
• CMake: find_package(KF6 REQUIRED COMPONENTS NetworkManagerQt)
target_link_libraries(mytarget PRIVATE KF6::NetworkManagerQt)
• Inherits: NetworkManager::Device

List of all members, including inherited members

#Public Types

• IpTunnelDevice::List
• IpTunnelDevice::Ptr

#Properties

• [read-only] encapsulationLimit : uchar
• [read-only] flowLabel : uint
• [read-only] inputKey : QString
• [read-only] local : QString
• [read-only] mode : uint
• [read-only] outputKey : QString
• [read-only] parent : NetworkManager::Device::Ptr
• [read-only] pathMtuDiscovery : bool
• [read-only] remote : QString
• [read-only] tos : uchar
• [read-only] ttl : uchar

#Public Functions

• IpTunnelDevice(const QString &path, QObject *parent = nullptr)
• uchar encapsulationLimit() const
• uint flowLabel() const
• QString inputKey() const
• QString local() const
• uint mode() const
• QString outputKey() const
• NetworkManager::Device::Ptr parent() const
• bool pathMtuDiscovery() const
• QString remote() const
• uchar tos() const
• uchar ttl() const

#Signals

• void encapsulationLimitChanged(uchar limit)
• void flowLabelChanged(uint flowLabel)
• void inputKeyChanged(const QString &inputKey)
• void localChanged(const QString &local)
• void modeChanged(uint mode)
• void outputKeyChanged(const QString &outputKey)
• void parentChanged(const QString &parent)
• void pathMtuDiscoveryChanged(bool pathMtuDiscovery)
• void remoteChanged(const QString &remote)
• void tosChanged(uchar tos)
• void ttlChanged(uchar ttl)

#Detailed Description

#Member Type Documentation

#IpTunnelDevice::List

#IpTunnelDevice::Ptr

#Property Documentation

#[read-only] encapsulationLimit : uchar

Access functions:

• uchar encapsulationLimit() const

Notifier signal:

• void encapsulationLimitChanged(uchar limit)

#[read-only] flowLabel : uint

Access functions:

• uint flowLabel() const

Notifier signal:

• void flowLabelChanged(uint flowLabel)

#[read-only] inputKey : QString

Access functions:

• QString inputKey() const

Notifier signal:

• void inputKeyChanged(const QString &inputKey)

#[read-only] local : QString

Access functions:

• QString local() const

Notifier signal:

• void localChanged(const QString &local)

#[read-only] mode : uint

Access functions:

• uint mode() const

Notifier signal:

• void modeChanged(uint mode)

#[read-only] outputKey : QString

Access functions:

• QString outputKey() const

Notifier signal:

• void outputKeyChanged(const QString &outputKey)

#[read-only] parent : NetworkManager::Device::Ptr

Access functions:

• NetworkManager::Device::Ptr parent() const

Notifier signal:

• void parentChanged(const QString &parent)

#[read-only] pathMtuDiscovery : bool

Access functions:

• bool pathMtuDiscovery() const

Notifier signal:

• void pathMtuDiscoveryChanged(bool pathMtuDiscovery)

#[read-only] remote : QString

Access functions:

• QString remote() const

Notifier signal:

• void remoteChanged(const QString &remote)

#[read-only] tos : uchar

Access functions:

• uchar tos() const

Notifier signal:

• void tosChanged(uchar tos)

#[read-only] ttl : uchar

Access functions:

• uchar ttl() const

Notifier signal:

• void ttlChanged(uchar ttl)

#Member Function Documentation

#[explicit] IpTunnelDevice::IpTunnelDevice(const QString &path, QObject *parent = nullptr)

#uchar IpTunnelDevice::encapsulationLimit() const

How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.

Note: Getter function for property encapsulationLimit.

#[signal] void IpTunnelDevice::encapsulationLimitChanged(uchar limit)

Emitted when the encapsulation limit has changed

Note: Notifier signal for property encapsulationLimit.

#uint IpTunnelDevice::flowLabel() const

The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.

Note: Getter function for property flowLabel.

#[signal] void IpTunnelDevice::flowLabelChanged(uint flowLabel)

Emitted when the flow label has changed

Note: Notifier signal for property flowLabel.

#QString IpTunnelDevice::inputKey() const

The key used for incoming packets.

Note: Getter function for property inputKey.

#[signal] void IpTunnelDevice::inputKeyChanged(const QString &inputKey)

Emitted when the key used for incoming packets has changed

Note: Notifier signal for property inputKey.

#QString IpTunnelDevice::local() const

The local endpoint of the tunnel.

Note: Getter function for property local.

#[signal] void IpTunnelDevice::localChanged(const QString &local)

Emitted when the local endpoint of the tunnel has changed

Note: Notifier signal for property local.

#uint IpTunnelDevice::mode() const

The tunneling mode.

Note: Getter function for property mode.

#[signal] void IpTunnelDevice::modeChanged(uint mode)

Emitted when the tunneling mode has changed

Note: Notifier signal for property mode.

#QString IpTunnelDevice::outputKey() const

The key used for outgoing packets.

Note: Getter function for property outputKey.

#[signal] void IpTunnelDevice::outputKeyChanged(const QString &outputKey)

Emitted when the key used for outgoing packets has changed

Note: Notifier signal for property outputKey.

#NetworkManager::Device::Ptr IpTunnelDevice::parent() const

The object path of the parent device.

Note: Getter function for property parent.

#[signal] void IpTunnelDevice::parentChanged(const QString &parent)

Emitted when the parent of this device has changed

Note: Notifier signal for property parent.

#bool IpTunnelDevice::pathMtuDiscovery() const

Whether path MTU discovery is enabled on this tunnel.

Note: Getter function for property pathMtuDiscovery.

#[signal] void IpTunnelDevice::pathMtuDiscoveryChanged(bool pathMtuDiscovery)

Emitted when the path MTU discovery enablemened has changed

Note: Notifier signal for property pathMtuDiscovery.

#QString IpTunnelDevice::remote() const

The remote endpoint of the tunnel.

Note: Getter function for property remote.

#[signal] void IpTunnelDevice::remoteChanged(const QString &remote)

Emitted when the remote endpoint of the tunnel has changed

Note: Notifier signal for property remote.

#uchar IpTunnelDevice::tos() const

The type of service (IPv4) or traffic class (IPv6) assigned to tunneled packets.

Note: Getter function for property tos.

#[signal] void IpTunnelDevice::tosChanged(uchar tos)

Emitted when the type of service or traffic class assigned to tunneled packets has changed

Note: Notifier signal for property tos.

#uchar IpTunnelDevice::ttl() const

The TTL assigned to tunneled packets. 0 is a special value meaning that packets inherit the TTL value

Note: Getter function for property ttl.

#[signal] void IpTunnelDevice::ttlChanged(uchar ttl)

Emitted when the TTL assigned to tunneled packets has changed

Note: Notifier signal for property ttl.