Класс VpnProfile

(Aurora::Mdm::Connectivity::VpnProfile)

Класс VpnProfile содержит параметры отдельного VPN-подключения. Подробнее…

Заголовочный файл:

#include <mdm-vpnmanager.h>

Список всех членов класса, включая унаследованные

Публичные типы

enum Error
enum State { Idle, Failure, Association, Configuration, ..., Online }

Свойства

autoConnect : bool
defaultRoute : bool
domain : QString
host : QString
name : QString
providerProperties : const QVariantMap
state : const State
type : QString
valid : const bool

Публичные методы

bool autoConnect() const
void connect()
bool defaultRoute() const
void disconnect()
QString domain() const
QString host() const
QString name() const
QVariantMap providerProperties() const
void remove()
void setAutoConnect(bool value)
void setDefaultRoute(bool value)
void setDomain(const QString &value)
void setHost(const QString &value)
void setName(const QString &value)
void setProviderProperty(const QString &name, const QVariant &value)
void setType(const QString &value)
State state() const
QString type() const
bool valid() const

Сигналы

void autoConnectChanged()
void connectFinished(Error result)
void defaultRouteChanged()
void disconnectFinished(Error result)
void domainChanged()
void hostChanged()
void nameChanged()
void providerPropertiesChanged()
void removeFinished(Error result)
void setAutoConnectFinished(Error result)
void setDefaultRouteFinished(Error result)
void setDomainFinished(Error result)
void setHostFinished(Error result)
void setNameFinished(Error result)
void setProviderPropertyFinished(const QString &name, Error result)
void setTypeFinished(Error result)
void stateChanged()
void typeChanged()
void validChanged()

Подробное описание

Класс VpnProfile содержит параметры отдельного VPN-подключения.

 CONFIG += link_pkgconfig
 PKGCONFIG += sailfishmdm

и затем #include <mdm-vpnmanager.h>.

Описание типов класса

enum VpnProfile::Error

Результат VPN-операции.

Константа	Значение	Описание
`Aurora::Mdm::Connectivity::VpnProfile::Success`	`0`	Операция прошла успешно.
`Aurora::Mdm::Connectivity::VpnProfile::InternalError`	`1`	Произошла внутренняя ошибка.

enum VpnProfile::State

Статус VPN-подключения.

Константа	Значение	Описание
`Aurora::Mdm::Connectivity::VpnProfile::Idle`	`0`	Соединение не установлено.
`Aurora::Mdm::Connectivity::VpnProfile::Failure`	`1`	Произошла ошибка подключения.
`Aurora::Mdm::Connectivity::VpnProfile::Association`	`2`	Соединение устанавливается
`Aurora::Mdm::Connectivity::VpnProfile::Configuration`	`3`	Соединение настраивается.
`Aurora::Mdm::Connectivity::VpnProfile::Ready`	`4`	Соединение установлено.
`Aurora::Mdm::Connectivity::VpnProfile::Disconnect`	`5`	Выполняется отключение.
`Aurora::Mdm::Connectivity::VpnProfile::Online`	`6`	Соединение установлено, и есть доступ в интернет.

Описание свойств

autoConnect : bool

true, если VPN-соединение должно подключаться автоматически, в противном случае содержит false.

Методы доступа:

bool autoConnect() const
void setAutoConnect(bool value)

Сигнал уведомления:

void autoConnectChanged()

defaultRoute : bool

true, если это маршрут по умолчанию для всех сетевых соединений, иначе содержит false.

Методы доступа:

bool defaultRoute() const
void setDefaultRoute(bool value)

Сигнал уведомления:

void defaultRouteChanged()

domain : QString

Домен VPN-подключения.

Методы доступа:

QString domain() const
void setDomain(const QString &value)

Сигнал уведомления:

void domainChanged()

host : QString

Хост VPN-подключения.

Методы доступа:

QString host() const
void setHost(const QString &value)

Сигнал уведомления:

void hostChanged()

name : QString

Название VPN-подключения.

Методы доступа:

QString name() const
void setName(const QString &value)

Сигнал уведомления:

void nameChanged()

providerProperties : const QVariantMap

Все не системные VPN-подключения.

Методы доступа:

QVariantMap providerProperties() const

Сигнал уведомления:

void providerPropertiesChanged()

state : const State

Текущее состояние VPN-соединения.

Методы доступа:

State state() const

Сигнал уведомления:

void stateChanged()

type : QString

Тип VPN-подключения. Тип — это название одного из установленных VPN-провайдеров, например "openvpn", "vpnc".

Методы доступа:

QString type() const
void setType(const QString &value)

Сигнал уведомления:

void typeChanged()

valid : const bool

true, если VPN-соединение существует, иначе содержит false.

Методы доступа:

bool valid() const

Сигнал уведомления:

void validChanged()

Описание методов класса

void VpnProfile::connect()

Начинает подключаться к данному VPN. После начала подключения испускается сигнал connectFinished. Для мониторинга состояния подключения, см. state() and stateChanged(). Завершается неудачно, если соединение уже установлено.

[signal] void VpnProfile::connectFinished(Error result)

Испускается после завершения процесса подключения. Параметр result содержит результат.

void VpnProfile::disconnect()

Начинает отключение от VPN. После начала отключения испускается сигнал disconnectFinished. Для мониторинга состояния подключения, см. state() and stateChanged().

[signal] void VpnProfile::disconnectFinished(Error result)

Испускается после завершения процесса отключения. Параметр result содержит результат.

void VpnProfile::remove()

Удаляет VPN-профиль. По завершении операции испускается сигнал removeFinished. Удалённые VPN-профили помечаются как недействительные. См. также valid(), validChanged().

[signal] void VpnProfile::removeFinished(Error result)

Испускается после завершения процесса удаления. Параметр result содержит результат.

void VpnProfile::setAutoConnect(bool value)

Устанавливает автоматическое подключение VPN в соответствии со значением value. По завершении операции испускается сигнал setAutoConnectFinished.

Примечание. Сеттер для свойства autoConnect.

См. также autoConnect().

[signal] void VpnProfile::setAutoConnectFinished(Error result)

Испускается после завершения метода setAutoConnect. Параметр result содержит результат.

void VpnProfile::setDefaultRoute(bool value)

Устанавливает раздельную маршрутизацию для VPN-подключения в соответствии со значением value. По завершении операции испускается сигнал setDefaultRouteFinished.

Примечание. Сеттер для свойства defaultRoute.

См. также defaultRoute().

[signal] void VpnProfile::setDefaultRouteFinished(Error result)

Испускается после завершения метода setDefaultRoute. Параметр result содержит результат.

void VpnProfile::setDomain(const QString &value)

Устанавливает для нового домена VPN-подключения значение value. По завершении операции испускается сигнал setDomainFinished.

Примечание. Сеттер для свойства domain.

См. также domain().

[signal] void VpnProfile::setDomainFinished(Error result)

Испускается после завершения метода setDomain. Параметр result содержит результат.

void VpnProfile::setHost(const QString &value)

Устанавливает для нового хоста VPN-подключения значение value. По завершении операции испускается сигнал setHostFinished.

Примечание. Сеттер для свойства host.

См. также host().

[signal] void VpnProfile::setHostFinished(Error result)

Испускается после завершения метода setHost. Параметр result содержит результат.

void VpnProfile::setName(const QString &value)

Устанавливает новому VPN-подключению имя value. По завершении операции испускается сигнал setNameFinished.

Примечание. Сеттер для свойства name.

См. также name().

[signal] void VpnProfile::setNameFinished(Error result)

Испускается после завершения метода setName. Параметр result содержит результат.

void VpnProfile::setProviderProperty(const QString &name, const QVariant &value)

Устанавливает свойству провайдера name значение value. По завершении операции испускается сигнал setProviderPropertyFinished. Это единственный случай, когда может возникнуть ошибка Error::ReservedProperty.

[signal] void VpnProfile::setProviderPropertyFinished(const QString &name, Error result)

Испускается после завершения метода setProviderProperty. Параметр result содержит результат. Параметр name содержит имя свойства.

void VpnProfile::setType(const QString &value)

Устанавливает для типа нового VPN-подключения значение value. По завершении операции испускается сигнал setTypeFinished.

Примечание. Сеттер для свойства type.

См. также type().

[signal] void VpnProfile::setTypeFinished(Error result)

Испускается после завершения метода setType. Параметр result содержит результат.