CONFIG += link_pkgconfig
 PKGCONFIG += sailfishmdm

 #include <mdm-netproxy.h>
 void setGlobalProxy(const QUrl &server)
 {
     auto proxy = new Sailfish::Mdm::NetProxy(nullptr);

     QObject::connect(proxy, &Sailfish::Mdm::NetProxy::validChanged, [proxy, server] {
         QString identifier = "global";
         bool found = proxy->selectProxy(identifier);

         if (found) {
             proxy->setType(Sailfish::Mdm::NetProxy::ProxyType::Manual);
             proxy->setManualProxies(QList<QUrl>({server}));
             proxy->setManualExclusions(QStringList());
         }
     });
 }

 #include <QCoreApplication>
 #include <QTimer>
 #include <mdm-netproxy.h>

 int main(int argc, char *argv[])
 {
     QCoreApplication app(argc, argv);

     // Set the global proxy
     setGlobalProxy(QUrl("https://jolla.com"));

     // Wait for a bit and then quit
     QTimer::singleShot(5000, [&app] {
         app.quit();
     });

     return app.exec();
 }

Member Function Documentation

NetProxy::NetProxy(QObject *parent = nullptr)

Constructs a new NetProxy with the given parent.

[virtual] NetProxy::~NetProxy()

Destroys the instance of NetProxy. The destructor is virtual.

[signal] void NetProxy::activeTypeChanged(ActiveType type)

Signal sent if the currently active proxy type switches from the service proxies to the global proxy or vice versa.

Note: Notifier signal for property activeType.

See also ActiveType, activeType, activeType(), and setActiveType().

[signal] void NetProxy::automaticUrlChanged(const QUrl &url)

The url for the currently selected service automatic proxy has changed.

Signal sent if the proxy is set to automatic, and the url of the PAC file to use to determine the proxy changes, for the currently selected service.

Note: Notifier signal for property automaticUrl.

See also automaticUrl and setAutomaticUrl().

QString NetProxy::getIdentifier() const

Returns the identifier for the currently selected service.

This will be the same identifier that was original used to select the service, and will also be one of the identifiers returned by calling getIdentifiers().

If the global proxy is selected, then the identifier returned will be global.

If no proxy is currently selected, an empty string will be returned.

QStringList NetProxy::getIdentifiers(const QString &technology) const

Returns a list of unique identifiers to the services which support proxies.

The identifiers will match those provided by connman. The usual use for this method is to extract the appropriate identifier for passing in to the selectProxy() method.

Identifiers can be listed filtered by technology. Passing an empty string will return all identifiers, regardless of technology.

In addition to the connman services, the identifier global will also be returned under the global technology, in reference to the global proxy.

See also getTechnologies() and selectProxy().

QString NetProxy::getName() const

Returns the human-readable name of the currently selected service.

If the global proxy is selected, then the identifier returned will be Global Proxy.

If no proxy is currently selected, an empty string will be returned.

QStringList NetProxy::getTechnologies() const

Returns the networking technologies that support proxy configuration.

The technologies will match those provided by connman, such as wifi or cellular. In addition a global technology will be returned, which refers to the global proxy.

See also getIdentifiers().

[signal] void NetProxy::manualExclusionsChanged(const QStringList &exclusions)

The list of exclusions for the currently selected service manual proxy has changed.

Signal sent if the proxy is set to manual, and the list of exclusions to use to determine the proxy changes, for the currently selected service.

Note: Notifier signal for property manualExclusions.

See also manualExclusions and setManualExclusions().

[signal] void NetProxy::manualProxiesChanged(const QList<QUrl> &proxies)

The list of proxies for the currently selected service manual proxy has changed.

Signal sent if the proxy is set to manual, and the list of proxies to use to determine the proxy changes, for the currently selected service.

Note: Notifier signal for property manualProxies.

See also manualProxies and setManualProxies().

[signal] void NetProxy::proxyConfigChanged()

Signal sent if any of the proxy configuration values for the currently selected service change.

This includes the proxy type, server list, exclusions list and url. It may also be triggered by a switch from service proxies to the global proxy or vice versa.

If you're interested in the change of a specific property it may be more convenient to connect to the singal for the specific property.

bool NetProxy::selectProxy(const QString &identifier)

Select a proxy to operate on.

Many different proxies may be operational on a device at once. To make changes to a specific proxy relating to a specific services, the proxy must first be selected using this method. Once selected, the other NetProxy operations, such as setting the proxy method, can then be used.

A common approach is to list the identifiers using getIdentifiers(), pass an identifier to selectProxy, and then perform further operations on the proxy using other NetProxy methods.

The global identifier should be used to select the global proxy. The identifier must be one of the values returned by getIdentifiers().

Returns true if the selection succeeded, false otherwise.

See also getIdentifiers().

bool NetProxy::setActiveType(ActiveType type)

Set whether the individal service proxies or global proxy should be active.

Pass in a type to set either the services proxies as being active, or the global proxy as being active.

Either individual service proxies can be applied, or the global proxy, but not both at the same time. This method allows switching between the two.

Returns true if the type was set, or false if no change was made (for example in case an attempt is made to set it to the current value).

Fails silently in the case of asynchronous errors.

Note: Setter function for property activeType.

See also ActiveType, activeType, activeType(), and activeTypeChanged().

bool NetProxy::setAutomaticUrl(const QUrl &url)

Set the URL of the PAC file to use for the currently selected service to url.

This configuration option only applies to the automatic proxy type.

In the case of an automatic proxy, the proxy is determined by a PAC file, which contains a JavaScript routine for selecting an appropriate proxy, based on the details of the request being made. This configuration option specifies the location of the PAC file to use.

Returns true if the value changed, or false otherwise. Situations in which false could be returned include if the value did not change, or there is no currently selected service.

Fails silently in the case of asynchronous errors.

Note: Setter function for property automaticUrl.

See also automaticUrl and automaticUrlChanged().

bool NetProxy::setManualExclusions(const QStringList &exclusions)

Set the domain exclusions for the currently selected service.

This configuration option only applies to the manual proxy type.

In the case of a manual proxy, a proxy is chosen from a list of configured proxies. However, if the request is being made to one of the excluded domains, then a direct request will be made instead.

Returns true if the value changed, or false otherwise. Situations in which false could be returned include if the value did not change, or there is no currently selected service.

Fails silently in the case of asynchronous errors.

Note: Setter function for property manualExclusions.

See also manualExclusions and manualExclusionsChanged().

bool NetProxy::setManualProxies(const QList<QUrl> &proxies)

Set the proxies proxy servers to use for the currently selected manually configured proxy.

This configuration option only applies to the manual proxy type.

In the case of a manual proxy, the proxy to be used will be chosen from the list of proxies supplied.

Returns true if the value changed, or false otherwise. Situations in which false could be returned include if the value did not change, or there is no currently selected service.

Fails silently in the case of asynchronous errors.

Note: Setter function for property manualProxies.

See also manualProxies and manualProxiesChanged().

bool NetProxy::setType(ProxyType type)

Set the type of the currently selected proxy.

A proxy can either by direct, in which case there is no proxy in use, it can be manual, in which case a specific list of proxies must be provided, or it is auto, in which case the proxy is chosen by reference to a PAC file, which chooses which proxy to use based on the contents of the PAC file (which is actually a piece of JavasScript logic).

Returns true if the value changed, or false otherwise. Situations in which false could be returned include if the value did not change, or there is no currently selected service.

Fails silently in the case of asynchronous errors.

Note: Setter function for property type.

See also ProxyType, type, type(), and typeChanged().

ProxyType NetProxy::type() const

Returns the type of the currently selected proxy.

A proxy can either by direct, in which case there is no proxy in use, it can be manual, in which case a specific list of proxies must be provided, or it is auto, in which case the proxy is chosen by reference to a PAC file, which chooses which proxy to use based on the contents of the PAC file (which is actually a piece of JavaScript logic).

Note: Getter function for property type.

See also ProxyType and setType().

[signal] void NetProxy::typeChanged(ProxyType type)

The type of currently selected proxy, either service or global, has changed.

Signal sent if the type of the currently selected proxy is switched from service to global or vice versa.

Note: Notifier signal for property type.

See also ProxyType, type, type(), and setType().