Solid::Networking Namespace Reference

Classes
class	Notifier

Enumerations
enum	ManagementPolicy { Manual, OnNextStatusChange, Managed }
enum	Status {   Unknown, Unconnected, Disconnecting, Connecting,   Connected }

Functions
SOLID_EXPORT ManagementPolicy	connectPolicy ()
SOLID_EXPORT ManagementPolicy	disconnectPolicy ()
SOLID_EXPORT Notifier *	notifier ()
SOLID_EXPORT void	setConnectPolicy (ManagementPolicy policy)
SOLID_EXPORT void	setDisconnectPolicy (ManagementPolicy policy)
SOLID_EXPORT Status	status ()

Detailed Description

This namespace contains all the network-related high-level methods: querying the underlying system for network availability, being notified when network availability changes (e.g.

due to interfaces appearing or disappearing).

It also allows application to specify the connection and disconnection policies that it would like to use, for the network.

Enumeration Type Documentation

enum Solid::Networking::ManagementPolicy

This defines application policy in response to networking connect/disconnect events.

Enumerator
Manual	Manual - the app should only disconnect when the user does so manually.
OnNextStatusChange	the app should connect or disconnect the next time the network changes status, thereafter Manual
Managed	the app should connect or disconnect whenever the KConnectionManager reports a state change

Definition at line 56 of file networking.h.

enum Solid::Networking::Status

Describes the state of the networking system.

Enumerator
Unknown	the networking system is not active or unable to report its status - proceed with caution
Unconnected	the system is not connected to any network
Disconnecting	the system is breaking the connection
Connecting	the system is not connected to any network
Connected	the system is currently connected to a network

Definition at line 45 of file networking.h.

Function Documentation

Solid::Networking::ManagementPolicy Solid::Networking::connectPolicy

(

)

Retrieve a policy managing the application's connect behaviour.

Returns

the connection policy in use

Definition at line 138 of file networking.cpp.

Solid::Networking::ManagementPolicy Solid::Networking::disconnectPolicy

(

)

Retrieve a policy managing the application's disconnect behaviour.

Returns

the disconnection policy in use

Definition at line 148 of file networking.cpp.

Solid::Networking::Notifier * Solid::Networking::notifier

(

)

Definition at line 85 of file networking.cpp.

void Solid::Networking::setConnectPolicy

(

ManagementPolicy

policy

)

Set a policy to manage the application's connect behaviour.

Parameters

policy

the new connection policy

Definition at line 143 of file networking.cpp.

void Solid::Networking::setDisconnectPolicy

(

ManagementPolicy

policy

)

Set a policy to manage the application's disconnect behaviour.

Parameters

policy

the new disconnection policy

Definition at line 153 of file networking.cpp.

Solid::Networking::Status Solid::Networking::status

(

)

Get the current networking status If the result is Unknown, the backend may be unconfigured or otherwise in a state where it cannot report useful networking status Solid::Networking::Status.

Definition at line 80 of file networking.cpp.