workspace/libs/solid/control/network.h

   1 /*  This file is part of the KDE project
   2     Copyright (C) 2006 Will Stephenson <wstephenson@kde.org>
   3     Copyright (C) 2007 Kevin Ottens <ervin@kde.org>
   4
   5     This library is free software; you can redistribute it and/or
   6     modify it under the terms of the GNU Library General Public
   7     License version 2 as published by the Free Software Foundation.
   8
   9     This library is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12     Library General Public License for more details.
  13
  14     You should have received a copy of the GNU Library General Public License
  15     along with this library; see the file COPYING.LIB.  If not, write to
  16     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17     Boston, MA 02110-1301, USA.
  18
  19 */
  20
  21 #ifndef SOLID_NETWORK_H
  22 #define SOLID_NETWORK_H
  23
  24 #include <QtCore/QObject>
  25 #include <QtCore/QStringList>
  26 #include <QtNetwork/QNetworkAddressEntry>
  27
  28 #include <solid/control/solid_control_export.h>
  29
  30 namespace Solid
  31 {
  32 namespace Control
  33 {
  34     class NetworkInterface;
  35     class NetworkInterfacePrivate;
  36     class NetworkPrivate;
  37
  38     /**
  39      * This interface represents a generic Internet Protocol (IP) network which we may be connected to.
  40      */
  41     class SOLIDCONTROL_EXPORT Network : public QObject
  42     {
  43         Q_OBJECT
  44         Q_DECLARE_PRIVATE(Network)
  45
  46     public:
  47         /**
  48          * Creates a new Network object.
  49          *
  50          * @param backendObject the network object provided by the backend
  51          */
  52         Network(QObject *backendObject = 0);
  53
  54         /**
  55          * Constructs a copy of a network.
  56          *
  57          * @param network the network to copy
  58          */
  59         Network(const Network &network);
  60
  61         /**
  62          * Destroys a Network object.
  63          */
  64         virtual ~Network();
  65
  66         /**
  67          * Indicates if this network is valid.
  68          * A network is considered valid if it's available to the system.
  69          *
  70          * @return true if this network is available, false otherwise
  71          */
  72         bool isValid() const;
  73
  74         /**
  75          * Retrieves the Unique Network Identifier (UNI) of the Network.
  76          * This identifier is unique for each network and network interface in the system.
  77          *
  78          * @returns the Unique Network Identifier of the current network
  79          */
  80         QString uni() const;
  81
  82
  83
  84         /**
  85          * Retrieves the addresses that the device has on this network.
  86          *
  87          * @return the list of addresses
  88          */
  89         QList<QNetworkAddressEntry> addressEntries() const;
  90
  91         /**
  92          * Retrieves the route we must follow when using this network. It's
  93          * in particular used for VPN.
  94          *
  95          * @return the route address is available, QString() otherwise
  96          */
  97         QString route() const;
  98
  99         /**
 100          * Retrieves the list of DNS servers to use on this network.
 101          *
 102          * @return the dns servers
 103          */
 104         QList<QHostAddress> dnsServers() const;
 105
 106         /**
 107          * Retrieves the activation status of this network. For ethernets, this will always be true.
 108          *
 109          * @return true if this network is active, false otherwise
 110          */
 111         bool isActive() const;
 112
 113         /**
 114          * Activates or deactivates this network. For ethernets, this has no effect.
 115          *
 116          * @param activated true to activate this network, false otherwise
 117          */
 118         void setActivated(bool activated);
 119
 120     Q_SIGNALS:
 121         /**
 122          * This signal is emitted when the settings of this network have changed.
 123          */
 124         void ipDetailsChanged();
 125
 126         /**
 127          * This signal is emitted when the activation state of this network
 128          * has changed.
 129          *
 130          * @param activated true if the network is activated, false otherwise
 131          */
 132         void activationStateChanged(bool activated);
 133
 134     protected:
 135         /**
 136          * @internal
 137          */
 138         Network(NetworkPrivate &dd, QObject *backendObject);
 139
 140         /**
 141          * @internal
 142          */
 143         Network(NetworkPrivate &dd, const Network &network);
 144
 145         NetworkPrivate *d_ptr;
 146
 147     private:
 148         friend class NetworkInterface;
 149         friend class NetworkInterfacePrivate;
 150     //HACK: to make NetworkList polymorphic (containing both wired and wireless networks, I used Network * here - Will.
 151     };
 152     typedef QList<Network *> NetworkList;
 153
 154
 155 } //Control
 156 } //Solid
 157
 158 #endif
 159