File indexing completed on 2024-04-28 03:52:00

 /*
  * BluezQt - Asynchronous BlueZ wrapper library
  *
  * SPDX-FileCopyrightText: 2014-2015 David Rosca <nowrep@gmail.com>
  *
  * SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
  */
 
 #ifndef BLUEZQT_ADAPTER_H
 #define BLUEZQT_ADAPTER_H
 
 #include <QList>
 #include <QObject>
 #include <QStringList>
 
 #include "bluezqt_export.h"
 #include "types.h"
 
 #include <memory>
 
 namespace BluezQt
 {
 class Device;
 class PendingCall;
 
 /**
  * @class BluezQt::Adapter adapter.h <BluezQt/Adapter>
  *
  * Bluetooth adapter.
  *
  * This class represents a Bluetooth adapter.
  */
 class BLUEZQT_EXPORT Adapter : public QObject
 {
     Q_OBJECT
 
     Q_PROPERTY(QString ubi READ ubi)
     Q_PROPERTY(QString address READ address)
     Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
     Q_PROPERTY(QString systemName READ systemName NOTIFY systemNameChanged)
     Q_PROPERTY(quint32 adapterClass READ adapterClass NOTIFY adapterClassChanged)
     Q_PROPERTY(bool powered READ isPowered WRITE setPowered NOTIFY poweredChanged)
     Q_PROPERTY(bool discoverable READ isDiscoverable WRITE setDiscoverable NOTIFY discoverableChanged)
     Q_PROPERTY(quint32 discoverableTimeout READ discoverableTimeout WRITE setDiscoverableTimeout NOTIFY discoverableTimeoutChanged)
     Q_PROPERTY(bool pairable READ isPairable WRITE setPairable NOTIFY pairableChanged)
     Q_PROPERTY(quint32 pairableTimeout READ pairableTimeout WRITE setPairableTimeout NOTIFY pairableTimeoutChanged)
     Q_PROPERTY(bool discovering READ isDiscovering NOTIFY discoveringChanged)
     Q_PROPERTY(QStringList uuids READ uuids NOTIFY uuidsChanged)
     Q_PROPERTY(QString modalias READ modalias NOTIFY modaliasChanged)
     Q_PROPERTY(LEAdvertisingManagerPtr leAdvertisingManager READ leAdvertisingManager NOTIFY leAdvertisingManagerChanged)
     Q_PROPERTY(MediaPtr media READ media NOTIFY mediaChanged)
     Q_PROPERTY(QList<DevicePtr> devices READ devices)
 
 public:
     /**
      * Destroys an Adapter object.
      */
     ~Adapter() override;
 
     /**
      * Returns a shared pointer from this.
      *
      * @return AdapterPtr
      */
     AdapterPtr toSharedPtr() const;
 
     /**
      * Returns an UBI of the adapter.
      *
      * Example UBI: "/org/bluez/hci0"
      *
      * @return UBI of adapter
      */
     QString ubi() const;
 
     /**
      * Returns an address of the adapter.
      *
      * Example address: "1C:E5:C3:BC:94:7E"
      *
      * @return address of adapter
      */
     QString address() const;
 
     /**
      * Returns a name of the adapter.
      *
      * @return name of adapter
      */
     QString name() const;
 
     /**
      * Sets the name of the adapter.
      *
      * @param name name of adapter
      * @return void pending call
      */
     PendingCall *setName(const QString &name);
 
     /**
      * Returns a system name (hostname) of the adapter.
      *
      * @return system name of adapter
      */
     QString systemName() const;
 
     /**
      * Returns a class of the adapter.
      *
      * @return class of adapter
      */
     quint32 adapterClass() const;
 
     /**
      * Returns whether the adapter is powered on.
      *
      * @return true if adapter is powered on
      */
     bool isPowered() const;
 
     /**
      * Sets the powered state of the adapter.
      *
      * @param powered powered state
      * @return void pending call
      */
     PendingCall *setPowered(bool powered);
 
     /**
      * Returns whether the adapter is discoverable by other devices.
      *
      * @return true if adapter is discoverable
      */
     bool isDiscoverable() const;
 
     /**
      * Sets the discoverable state of the adapter.
      *
      * @param discoverable discoverable state
      * @return void pending call
      */
     PendingCall *setDiscoverable(bool discoverable);
 
     /**
      * Returns the discoverable timeout in seconds of the adapter.
      *
      * Discoverable timeout defines how long the adapter stays in
      * discoverable state after calling setDiscoverable(true).
      *
      * Timeout 0 means infinitely.
      *
      * @return discoverable timeout of adapter
      */
     quint32 discoverableTimeout() const;
 
     /**
      * Sets the discoverable timeout of the adapter.
      *
      * @param timeout timeout in seconds
      * @return void pending call
      */
     PendingCall *setDiscoverableTimeout(quint32 timeout);
 
     /**
      * Returns whether the adapter is pairable with other devices.
      *
      * @return true if adapter is pairable
      */
     bool isPairable() const;
 
     /**
      * Sets the pairable state of the adapter.
      *
      * @param pairable pairable state
      * @return void pending call
      */
     PendingCall *setPairable(bool pairable);
 
     /**
      * Returns the pairable timeout in seconds of the adapter.
      *
      * Pairable timeout defines how long the adapter stays in
      * pairable state after calling setPairable(true).
      *
      * Timeout 0 means infinitely.
      *
      * @return pairable timeout of adapter
      */
     quint32 pairableTimeout() const;
 
     /**
      * Sets the pairable timeout of the adapter.
      *
      * @param timeout timeout in seconds
      * @return void pending call
      */
     PendingCall *setPairableTimeout(quint32 timeout);
 
     /**
      * Returns whether the adapter is discovering for other devices
      *
      * @return true if adapter is discovering
      */
     bool isDiscovering();
 
     /**
      * Returns UUIDs of supported services by the adapter.
      *
      * UUIDs will always be returned in uppercase.
      *
      * @return UUIDs of supported services
      */
     QStringList uuids() const;
 
     /**
      * Returns local device ID in modalias format.
      *
      * @return adapter modalias
      */
     QString modalias() const;
 
     /**
      * Returns the GATT manager interface for the adapter.
      *
      * @return null if adapter have no GATT manager
      */
     GattManagerPtr gattManager() const;
 
     /**
      * Returns the LE advertising manager interface for the adapter.
      *
      * @return null if adapter have no Bluetooth LE
      */
     LEAdvertisingManagerPtr leAdvertisingManager() const;
 
     /**
      * Returns the media interface for the adapter.
      *
      * @return null if adapter have no media
      */
     MediaPtr media() const;
 
     /**
      * Returns list of devices known by the adapter.
      *
      * @return list of devices
      */
     QList<DevicePtr> devices() const;
 
     /**
      * Returns a device for specified address.
      *
      * @param address address of device (eg. "40:79:6A:0C:39:75")
      * @return null if there is no device with specified address
      */
     DevicePtr deviceForAddress(const QString &address) const;
 
     /**
      * Starts device discovery.
      *
      * Possible errors: PendingCall::NotReady, PendingCall::Failed
      *
      * @return void pending call
      * @see discoverableTimeout() const
      */
     PendingCall *startDiscovery();
 
     /**
      * Stops device discovery.
      *
      * Possible errors: PendingCall::NotReady, PendingCall::Failed, PendingCall::NotAuthorized
      *
      * @return void pending call
      */
     PendingCall *stopDiscovery();
 
     /**
      * Removes the specified device.
      *
      * It will also remove the pairing information.
      *
      * Possible errors: PendingCall::InvalidArguments, PendingCall::Failed
      *
      * @param device device to be removed
      * @return void pending call
      */
     PendingCall *removeDevice(DevicePtr device);
 
     /**
      * Set the discovery filter for the caller.
      *
      * When this method is called with no filter parameter, the filter is removed.
      *
      * For details and available filter options, see [Bluez documentation for Adapter object](https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/adapter-api.txt)
      *
      * Possible errors: PendingCall::InvalidArguments, PendingCall::Failed
      *
      * @param filter options dictionary
      * @return void pending call
      */
      PendingCall *setDiscoveryFilter(const QVariantMap& filter);
 
     /**
      * Get the discovery filters for the caller.
      *
      * This returns the available filters that can be given to setDiscoveryFilter, for details see [Bluez documentation for Adapter object](https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/adapter-api.txt)
      *
      * Possible errors: PendingCall::Failed
      *
      * @return string list pending call
      */
      PendingCall *getDiscoveryFilters();
 
 Q_SIGNALS:
     /**
      * Indicates that the adapter was removed.
      */
     void adapterRemoved(AdapterPtr adapter);
 
     /**
      * Indicates that at least one of the adapter's properties have changed.
      */
     void adapterChanged(AdapterPtr adapter);
 
     /**
      * Indicates that adapter's name have changed.
      */
     void nameChanged(const QString &name);
 
     /**
      * Indicates that adapter's system name have changed.
      */
     void systemNameChanged(const QString &systemName);
 
     /**
      * Indicates that adapter's class have changed.
      */
     void adapterClassChanged(quint32 adapterClass);
 
     /**
      * Indicates that adapter's powered state have changed.
      */
     void poweredChanged(bool powered);
 
     /**
      * Indicates that adapter's discoverable state have changed.
      */
     void discoverableChanged(bool discoverable);
 
     /**
      * Indicates that adapter's discoverable timeout have changed.
      */
     void discoverableTimeoutChanged(quint32 timeout);
 
     /**
      * Indicates that adapter's pairable state have changed.
      */
     void pairableChanged(bool pairable);
 
     /**
      * Indicates that adapter's pairable timeout have changed.
      */
     void pairableTimeoutChanged(quint32 timeout);
 
     /**
      * Indicates that adapter's discovering state have changed.
      */
     void discoveringChanged(bool discovering);
 
     /**
      * Indicates that adapter's UUIDs have changed.
      */
     void uuidsChanged(const QStringList &uuids);
 
     /**
      * Indicates that adapter's modalias have changed.
      */
     void modaliasChanged(const QString &modalias);
 
     /**
      * Indicates that adapter's GATT manager have changed.
      */
     void gattManagerChanged(GattManagerPtr gattManager);
 
     /**
      * Indicates that adapter's LE advertising manager have changed.
      */
     void leAdvertisingManagerChanged(LEAdvertisingManagerPtr leAdvertisingManager);
 
     /**
      * Indicates that adapter's media have changed.
      */
     void mediaChanged(MediaPtr media);
 
     /**
      * Indicates that a new device was added (eg. found by discovery).
      */
     void deviceAdded(DevicePtr device);
 
     /**
      * Indicates that a device was removed.
      */
     void deviceRemoved(DevicePtr device);
 
     /**
      * Indicates that at least one of the device's properties have changed.
      */
     void deviceChanged(DevicePtr device);
 
 private:
     BLUEZQT_NO_EXPORT explicit Adapter(const QString &path, const QVariantMap &properties);
 
     std::unique_ptr<class AdapterPrivate> const d;
 
     friend class AdapterPrivate;
     friend class ManagerPrivate;
     friend class InitAdaptersJobPrivate;
 };
 
 } // namespace BluezQt
 
 #endif // BLUEZQT_ADAPTER_H