File indexing completed on 2024-04-28 15:17:56

 /*
  * 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_PROFILE_H
 #define BLUEZQT_PROFILE_H
 
 #include <QObject>
 
 #include "bluezqt_export.h"
 #include "request.h"
 #include "types.h"
 
 class QLocalSocket;
 class QDBusObjectPath;
 class QDBusUnixFileDescriptor;
 
 namespace BluezQt
 {
 class Device;
 
 /**
  * @class BluezQt::Profile profile.h <BluezQt/Profile>
  *
  * Bluetooth profile.
  *
  * This class represents a Bluetooth profile.
  *
  * It is only needed to reimplement pure virtual functions.
  * You don't need to set any additional properties.
  *
  * But you may need to specify at least channel number or PSM in case it couldn't be
  * determined from UUID. It is also a good idea to provide name for the profile.
  *
  * Setting the channel number with setChannel() will make the profile use RFCOMM, while
  * setting the PSM with setPsm() will make the profile use L2CAP.
  *
  * @note The return value of requests will be sent asynchronously with Request class.
  *       It is also possible to cancel/reject all requests.
  *
  */
 class BLUEZQT_EXPORT Profile : public QObject
 {
     Q_OBJECT
 
     Q_PROPERTY(QString uuid READ uuid)
 
 public:
     /** Local role to identify sides in asymmetric profiles. */
     enum LocalRole {
         /** Indicates that this is a client. */
         ClientRole,
         /** Indicates that this is a server. */
         ServerRole,
     };
 
     /**
      * Creates a new Profile object.
      *
      * @param parent
      */
     explicit Profile(QObject *parent = nullptr);
 
     /**
      * Destroys a Profile object.
      */
     ~Profile() override;
 
     /**
      * D-Bus object path of the profile.
      *
      * The path where the profile will be registered.
      *
      * @note You must provide valid object path!
      *
      * @return object path of agent
      */
     virtual QDBusObjectPath objectPath() const = 0;
 
     /**
      * UUID of the profile.
      *
      * @return UUID of the profile
      */
     virtual QString uuid() const = 0;
 
     /**
      * Sets the human readable name of the profile.
      *
      * @param name name of the profile
      */
     void setName(const QString &name);
 
     /**
      * Sets the primary service class UUID (if different from profile UUID).
      *
      * @param service service UUID
      */
     void setService(const QString &service);
 
     /**
      * Sets the local role to identify side.
      *
      * For asymmetric profiles that do not have UUIDs available
      * to uniquely identify each side this parameter allows
      * specifying the precise local role.
      *
      * @param role local role
      */
     void setLocalRole(LocalRole role);
 
     /**
      * Sets the RFCOMM channel number.
      *
      * Available channel number range is 0-31.
      * Setting channel number to 0 will automatically choose
      * correct channel number for profile UUID.
      *
      * @param channel channel number
      */
     void setChannel(quint16 channel);
 
     /**
      * Sets the L2CAP port number.
      *
      * PSM (Protocol Service Multiplexer) is a port number
      * in L2CAP.
      *
      * Setting PSM to 0 will automatically choose correct
      * PSM for profile UUID.
      *
      * @param psm PSM
      */
     void setPsm(quint16 psm);
 
     /**
      * Sets whether the pairing is required to connect.
      *
      * @param require require to pair
      */
     void setRequireAuthentication(bool require);
 
     /**
      * Sets whether the authorization is required to connect.
      *
      * @param require require to authorize
      */
     void setRequireAuthorization(bool require);
 
     /**
      * Sets whether the profile is automatically connected.
      *
      * In case of a client UUID this will force connection
      * of the RFCOMM or L2CAP channels when a remote device
      * is connected.
      *
      * @param autoConnect autoconnect the profile
      */
     void setAutoConnect(bool autoConnect);
 
     /**
      * Sets a SDP record.
      *
      * This allows to provide a manual SDP record, otherwise it will
      * be generated automatically.
      *
      * @param serviceRecord SDP record
      */
     void setServiceRecord(const QString &serviceRecord);
 
     /**
      * Sets the profile version.
      *
      * @param version version of the profile
      */
     void setVersion(quint16 version);
 
     /**
      * Sets the profile features.
      *
      * @param features features of the profile
      */
     void setFeatures(quint16 features);
 
     /**
      * Creates a socket from file descriptor.
      *
      * @param fd socket file descriptor
      * @return socket
      *
      * @see newConnection()
      */
     QSharedPointer<QLocalSocket> createSocket(const QDBusUnixFileDescriptor &fd);
 
     /**
      * Requests the new connection.
      *
      * Common properties:
      * <ul>
      *  <li>quint16 Version - Profile version</li>
      *  <li>quint16 Features - Profile features</li>
      * </ul>
      *
      * To create socket from fd, you can use:
      * @code
      *  QSharedPointer<QLocalSocket> socket = createSocket(fd);
      *  if (!socket->isValid()) {
      *      delete socket;
      *      request.cancel();
      *      return;
      *  }
      * @endcode
      *
      * @param device device that requested connection
      * @param fd socket file descriptor
      * @param properties additional properties
      * @param request request to be used for sending reply
      */
     virtual void newConnection(DevicePtr device, const QDBusUnixFileDescriptor &fd, const QVariantMap &properties, const Request<> &request);
 
     /**
      * Requests the disconnection of the profile.
      *
      * This method gets called when a profile gets disconnected.
      *
      * @param device device to be disconnected
      * @param request request to be used for sending reply
      */
     virtual void requestDisconnection(DevicePtr device, const Request<> &request);
 
     /**
      * Indicates that the profile was unregistered.
      *
      * This method gets called when the Bluetooth daemon
      * unregisters the profile.
      *
      * A profile can use it to do cleanup tasks. There is no need
      * to unregister the profile, because when this method gets called
      * it has already been unregistered.
      *
      */
     virtual void release();
 
 private:
     class ProfilePrivate *const d;
 
     friend class Manager;
 };
 
 } // namespace BluezQt
 
 #endif // BLUEZQT_PROFILE_H