Solid::Networking Namespace Reference

This class allow to query the underlying system to discover the available network interfaces and reachable network.It has also the responsibility to notify when a network interface or a network appear or disappear. More...

Classes
class	Notifier
	This object emits signals, for use if your application requires notification of changes to networking. More...
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 class allow to query the underlying system to discover the available network interfaces and reachable network.It has also the responsibility to notify when a network interface or a network appear or disappear.

It's the unique entry point for network management. Applications should use it to find network interfaces, or to be notified about network related changes.

Note that it's implemented as a singleton and encapsulates the backend logic.

---

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 57 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 46 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 134 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 144 of file networking.cpp.

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

(

)

Definition at line 81 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 139 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 149 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 76 of file networking.cpp.