• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Solid

Solid::Networking

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

ManagementPolicy connectPolicy ()
ManagementPolicy disconnectPolicy ()
Notifier * notifier ()
void setConnectPolicy (ManagementPolicy policy)
void setDisconnectPolicy (ManagementPolicy policy)
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 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 119 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 129 of file networking.cpp.

Solid::Networking::Notifier * Solid::Networking::notifier (  ) 

Definition at line 65 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 124 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 134 of file networking.cpp.

Solid::Networking::Status Solid::Networking::status (  ) 

Get the current networking status.

Definition at line 60 of file networking.cpp.

Solid

Skip menu "Solid"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal