NetworkManager::VpnConnection

Search for usage in LXR

NetworkManager::VpnConnection Class Reference

#include <vpnconnection.h>

Inheritance diagram for NetworkManager::VpnConnection:

Public Types

typedef QList< PtrList
 
typedef QSharedPointer< VpnConnectionPtr
 
enum  State {
  Unknown = 0 , Prepare , NeedAuth , Connecting ,
  GettingIpConfig , Activated , Failed , Disconnected
}
 
enum  StateChangeReason {
  UnknownReason = 0 , NoneReason , UserDisconnectedReason , DeviceDisconnectedReason ,
  ServiceStoppedReason , IpConfigInvalidReason , ConnectTimeoutReason , ServiceStartTimeoutReason ,
  ServiceStartFailedReason , NoSecretsReason , LoginFailedReason , ConnectionRemovedReason
}
 
- Public Types inherited from NetworkManager::ActiveConnection
typedef QList< PtrList
 
typedef QSharedPointer< ActiveConnectionPtr
 
enum  Reason {
  UknownReason = 0 , None , UserDisconnected , DeviceDisconnected ,
  ServiceStopped , IpConfigInvalid , ConnectTimeout , ServiceStartTimeout ,
  ServiceStartFailed , NoSecrets , LoginFailed , ConnectionRemoved ,
  DependencyFailed , DeviceRealizeFailed , DeviceRemoved
}
 
enum  State {
  Unknown = 0 , Activating , Activated , Deactivating ,
  Deactivated
}
 

Signals

void bannerChanged (const QString &banner)
 
void stateChanged (NetworkManager::VpnConnection::State state, NetworkManager::VpnConnection::StateChangeReason reason)
 
- Signals inherited from NetworkManager::ActiveConnection
void connectionChanged (const NetworkManager::Connection::Ptr &connection)
 
void default4Changed (bool isDefault)
 
void default6Changed (bool isDefault)
 
void devicesChanged ()
 
void dhcp4ConfigChanged ()
 
void dhcp6ConfigChanged ()
 
void idChanged (const QString &id)
 
void ipV4ConfigChanged ()
 
void ipV6ConfigChanged ()
 
void masterChanged (const QString &uni)
 
void specificObjectChanged (const QString &path)
 
void stateChanged (NetworkManager::ActiveConnection::State state)
 
void stateChangedReason (NetworkManager::ActiveConnection::State state, NetworkManager::ActiveConnection::Reason reason)
 
void typeChanged (NetworkManager::ConnectionSettings::ConnectionType type)
 
void uuidChanged (const QString &uuid)
 
void vpnChanged (bool isVpn)
 

Public Member Functions

 VpnConnection (const QString &path, QObject *parent=nullptr)
 
 ~VpnConnection () override
 
QString banner () const
 
 operator VpnConnection * ()
 
NetworkManager::VpnConnection::State state () const
 
- Public Member Functions inherited from NetworkManager::ActiveConnection
 ActiveConnection (const QString &path, QObject *parent=nullptr)
 
 ~ActiveConnection () override
 
Connection::Ptr connection () const
 
bool default4 () const
 
bool default6 () const
 
QStringList devices () const
 
Dhcp4Config::Ptr dhcp4Config () const
 
Dhcp6Config::Ptr dhcp6Config () const
 
QString id () const
 
IpConfig ipV4Config () const
 
IpConfig ipV6Config () const
 
bool isValid () const
 
QString master () const
 
QString path () const
 
QString specificObject () const
 
NetworkManager::ActiveConnection::State state () const
 
NetworkManager::ConnectionSettings::ConnectionType type () const
 
QString uuid () const
 
bool vpn () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from NetworkManager::ActiveConnection
NETWORKMANAGERQT_NO_EXPORT ActiveConnection (ActiveConnectionPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Attributes inherited from NetworkManager::ActiveConnection
ActiveConnectionPrivate *const d_ptr
 

Detailed Description

An active VPN connection.

Definition at line 26 of file vpnconnection.h.

Member Typedef Documentation

◆ List

Definition at line 32 of file vpnconnection.h.

◆ Ptr

Member Enumeration Documentation

◆ State

Enum describing the possible VPN connection states.

Enumerator
Unknown 

The state of the VPN connection is unknown.

Prepare 

The VPN connection is preparing to connect.

NeedAuth 

The VPN connection needs authorization credentials.

Connecting 

The VPN connection is being established.

GettingIpConfig 

The VPN connection is getting an IP address.

Activated 

The VPN connection is active.

Failed 

The VPN connection failed.

Disconnected 

The VPN connection is disconnected.

Definition at line 36 of file vpnconnection.h.

◆ StateChangeReason

Enumerator
UnknownReason 

The reason for the VPN connection state change is unknown.

NoneReason 

No reason was given for the VPN connection state change.

UserDisconnectedReason 

The VPN connection changed state because the user disconnected it.

DeviceDisconnectedReason 

The VPN connection changed state because the device it was using was disconnected.

ServiceStoppedReason 

The service providing the VPN connection was stopped.

IpConfigInvalidReason 

The IP config of the VPN connection was invalid.

ConnectTimeoutReason 

The connection attempt to the VPN service timed out.

ServiceStartTimeoutReason 

A timeout occurred while starting the service providing the VPN connection.

ServiceStartFailedReason 

Starting the service starting the service providing the VPN connection failed.

NoSecretsReason 

Necessary secrets for the VPN connection were not provided.

LoginFailedReason 

Authentication to the VPN server failed.

ConnectionRemovedReason 

The connection was deleted from settings.

Definition at line 48 of file vpnconnection.h.

Constructor & Destructor Documentation

◆ VpnConnection()

NetworkManager::VpnConnection::VpnConnection ( const QString & path,
QObject * parent = nullptr )
explicit

Creates a new VpnConnection object.

Parameters
paththe DBus path of the device

Definition at line 35 of file vpnconnection.cpp.

◆ ~VpnConnection()

NetworkManager::VpnConnection::~VpnConnection ( )
override

Destroys a VpnConnection object.

Definition at line 66 of file vpnconnection.cpp.

Member Function Documentation

◆ banner()

QString NetworkManager::VpnConnection::banner ( ) const

Return the current login banner.

Definition at line 70 of file vpnconnection.cpp.

◆ bannerChanged

void NetworkManager::VpnConnection::bannerChanged ( const QString & banner)
signal

This signal is emitted when the connection banner has changed.

◆ operator VpnConnection *()

NetworkManager::VpnConnection::operator VpnConnection * ( )

operator for casting an ActiveConnection into a VpnConnection.

Returns 0 if this object is not a VPN connection. Introduced to make it possible to create a VpnConnection object for every active connection, without creating an ActiveConnection object, checking if it's a VPN connection, deleting the ActiveConnection and creating a VpnConnection

Definition at line 123 of file vpnconnection.cpp.

◆ state()

NetworkManager::VpnConnection::State NetworkManager::VpnConnection::state ( ) const

returns the current state

Definition at line 77 of file vpnconnection.cpp.

◆ stateChanged

void NetworkManager::VpnConnection::stateChanged ( NetworkManager::VpnConnection::State state,
NetworkManager::VpnConnection::StateChangeReason reason )
signal

This signal is emitted when the VPN connection state has changed.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 14 2024 12:00:32 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.