File indexing completed on 2024-04-21 15:06:32

 /*
     SPDX-FileCopyrightText: 2008, 2011 Will Stephenson <wstephenson@kde.org>
     SPDX-FileCopyrightText: 2011-2013 Lamarque V. Souza <lamarque@kde.org>
     SPDX-FileCopyrightText: 2013 Daniel Nicoletti <dantti12@gmail.com>
     SPDX-FileCopyrightText: 2013 Jan Grulich <jgrulich@redhat.com>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #ifndef NETWORKMANAGERQT_WIRELESSDEVICE_H
 #define NETWORKMANAGERQT_WIRELESSDEVICE_H
 
 #include "accesspoint.h"
 #include "device.h"
 #include "wirelessnetwork.h"
 #include <networkmanagerqt/networkmanagerqt_export.h>
 
 #include <QDBusObjectPath>
 #include <QDBusPendingReply>
 
 namespace NetworkManager
 {
 class WirelessDevicePrivate;
 
 /**
  * A wireless network interface
  */
 class NETWORKMANAGERQT_EXPORT WirelessDevice : public Device
 {
     Q_OBJECT
 
 public:
     typedef QSharedPointer<WirelessDevice> Ptr;
     typedef QList<Ptr> List;
 
     /**
      * The device's current operating mode
      */
     enum OperationMode {
         Unknown = 0, /**< not associated with a network */
         Adhoc, /**< part of an adhoc network */
         Infra, /**< a station in an infrastructure wireless network */
         ApMode, /**< access point in an infrastructure network */
     };
     Q_ENUM(OperationMode)
     /**
      * Capabilities (currently all encryption/authentication related) of the device
      * @note FreqValid, Freq2Ghz, Freq5Ghz are available in runtime NM >= 1.0.2
      */
     enum Capability {
         NoCapability = 0x0, /**< Null capability */
         Wep40 = 0x1, /**< 40 bit WEP cipher */
         Wep104 = 0x2, /**< 104 bit WEP cipher */
         Tkip = 0x4, /**< TKIP encryption cipher */
         Ccmp = 0x8, /**< CCMP encryption cipher */
         Wpa = 0x10, /**< WPA authentication protocol */
         Rsn = 0x20, /**< RSN authethication protocol */
         ApCap = 0x40, /**< The device supports Access Point mode. */
         AdhocCap = 0x80, /**< The device supports Ad-Hoc mode. */
         FreqValid = 0x100, /**< The device properly reports information about supported frequencies */
         Freq2Ghz = 0x200, /**< The device supports 2.4Ghz frequencies */
         Freq5Ghz = 0x400, /**< The device supports 5Ghz frequencies */
         Mesh = 0x1000, /**< The device supports acting as a mesh point */
         IBSSRsn = 0x2000, /**< device supports WPA2/RSN in an IBSS network */
     };
     Q_DECLARE_FLAGS(Capabilities, Capability)
     /**
      * Creates a new WirelessDevice object.
      *
      * @param path the DBus path of the devise
      */
     explicit WirelessDevice(const QString &path, QObject *parent = nullptr);
     /**
      * Destroys a WirelessDevice object.
      */
     ~WirelessDevice() override;
     /**
      * Return the type
      */
     Type type() const override;
     /**
      * List of wireless networks currently visible to the hardware
      */
     QStringList accessPoints() const;
     /**
      * Asks the device for a new scan of available wireless networks
      * @param options Options of scan
      * No documentation for options yet, see
      * https://projects.gnome.org/NetworkManager/developers/api/09/spec.html#org.freedesktop.NetworkManager.Device.Wireless
      */
     QDBusPendingReply<> requestScan(const QVariantMap &options = QVariantMap());
     /**
      * AccessPoint pointer this interface is currently associated with
      */
     AccessPoint::Ptr activeAccessPoint() const;
     /**
      * The permanent hardware address of the network interface
      */
     QString permanentHardwareAddress() const;
     /**
      * The hardware address currently used by the network interface
      */
     QString hardwareAddress() const;
 
     /**
      * Retrieves the operation mode of this network.
      *
      * @return the current mode
      * @see OperationMode
      */
     WirelessDevice::OperationMode mode() const;
     /**
      * Retrieves the effective bit rate currently attainable by this device.
      *
      * @return the bitrate in Kbit/s
      */
     int bitRate() const;
     /**
      * The LastScan property value, converted to QDateTime
      * @since 5.62.0
      * @note will always return invalid QDateTime when runtime NM < 1.12
      * @return
      */
     QDateTime lastScan() const;
     /**
      * The time the last RequestScan function was called
      * @since 5.62.0
      * @return
      */
     QDateTime lastRequestScan() const;
     /**
      * Retrieves the capabilities of this wifi network.
      *
      * @return the flag set describing the capabilities
      * @see Capabilities
      */
     WirelessDevice::Capabilities wirelessCapabilities() const;
 
     /**
      * Helper method to convert wire representation of operation mode to enum
      */
     static WirelessDevice::OperationMode convertOperationMode(uint);
     /**
      * Helper method to convert wire representation of capabilities to enum
      */
     static WirelessDevice::Capabilities convertCapabilities(uint);
     /**
      * Finds access point object given its Unique Network Identifier.
      *
      * @param uni the identifier of the AP to find from this network interface
      * @returns a valid AccessPoint object if a network having the given UNI for this device is known to the system, 0 otherwise
      */
     AccessPoint::Ptr findAccessPoint(const QString &uni);
 
     /**
      * Return the current list of networks
      */
     WirelessNetwork::List networks() const;
 
     /**
      * Find a network with the given @p ssid, a Null object is
      * returned if it can not be found
      */
     WirelessNetwork::Ptr findNetwork(const QString &ssid) const;
 
 Q_SIGNALS:
     /**
      * This signal is emitted when the bitrate of this network has changed.
      *
      * @param bitrate the new bitrate value for this network
      */
     void bitRateChanged(int bitrate);
     /**
      * The active network changed.
      */
     void activeAccessPointChanged(const QString &);
     /**
      * The device switched operating mode.
      */
     void modeChanged(WirelessDevice::OperationMode);
     /**
      * The device changed its capabilities
      */
     void wirelessCapabilitiesChanged(Capabilities);
     /**
      * The device changed its hardware address
      */
     void hardwareAddressChanged(const QString &);
     /**
      * The device changed its permanent hardware address
      */
     void permanentHardwareAddressChanged(const QString &);
     /**
      * The device changed its properties
      */
     void wirelessPropertiesChanged(uint); // TODO this is bogus, remove
     /**
      * A new wireless access point appeared
      */
     void accessPointAppeared(const QString &uni);
     /**
      * A wireless access point disappeared
      */
     void accessPointDisappeared(const QString &uni);
     /**
      * A wireless network appeared
      */
     void networkAppeared(const QString &ssid);
     /**
      * A wireless network disappeared
      */
     void networkDisappeared(const QString &ssid);
     /**
      * The LastScan property has changed, meaning a scan has just finished
      * @since 5.62.0
      * @note will never be emitted when runtime NM < 1.12
      * @see lastScanTime
      */
     void lastScanChanged(const QDateTime &dateTime);
 
 private:
     Q_DECLARE_PRIVATE(WirelessDevice)
 };
 
 } // namespace NetworkManager
 #endif // NETWORKMANAGERQT_WIRELESSDEVICE_H