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_OBEXTRANSFER_H
 #define BLUEZQT_OBEXTRANSFER_H
 
 #include <QObject>
 
 #include "bluezqt_export.h"
 #include "types.h"
 
 class QDBusObjectPath;
 
 namespace BluezQt
 {
 class PendingCall;
 
 /**
  * @class BluezQt::ObexTransfer obextransfer.h <BluezQt/ObexTransfer>
  *
  * OBEX transfer.
  *
  * This class represents transfer of one file.
  */
 class BLUEZQT_EXPORT ObexTransfer : public QObject
 {
     Q_OBJECT
 
     Q_PROPERTY(Status status READ status NOTIFY statusChanged)
     Q_PROPERTY(QString name READ name)
     Q_PROPERTY(QString type READ type)
     Q_PROPERTY(quint64 time READ time)
     Q_PROPERTY(quint64 size READ size)
     Q_PROPERTY(quint64 transferred READ transferred NOTIFY transferredChanged)
     Q_PROPERTY(QString fileName READ fileName NOTIFY fileNameChanged)
     Q_PROPERTY(bool suspendable READ isSuspendable)
 
 public:
     /**
      * Status of transfer.
      */
     enum Status {
         /** Indicates that the transfer is queued. */
         Queued,
         /** Indicates that the transfer is active. */
         Active,
         /** Indicates that the transfer is suspended. */
         Suspended,
         /** Indicates that the transfer have completed successfully. */
         Complete,
         /** Indicates that the transfer have failed with error. */
         Error,
         /** Indicates that the transfer status is unknown. */
         Unknown,
     };
     Q_ENUM(Status)
 
     /**
      * Destroys an ObexTransfer object.
      */
     ~ObexTransfer() override;
 
     /**
      * Returns a shared pointer from this.
      *
      * @return ObexTransferPtr
      */
     ObexTransferPtr toSharedPtr() const;
 
     /**
      * D-Bus object path of the transfer.
      *
      * @return object path of transfer
      */
     QDBusObjectPath objectPath() const;
 
     /**
      * Returns the status of the transfer.
      *
      * @return status of transfer
      */
     Status status() const;
 
     /**
      * Returns the name of the transferred object.
      *
      * @return name of transferred object
      */
     QString name() const;
 
     /**
      * Returns the type of the transferred object.
      *
      * @return type of transferred object
      */
     QString type() const;
 
     /**
      * Returns the time of the transferred object.
      *
      * @return time of transferred object
      */
     quint64 time() const;
 
     /**
      * Returns the total size of the transferred object.
      *
      * @return size of transferred object
      */
     quint64 size() const;
 
     /**
      * Returns the number of bytes transferred.
      *
      * @return number of bytes transferred
      */
     quint64 transferred() const;
 
     /**
      * Returns the full name of the transferred file.
      *
      * @return full name of transferred file
      */
     QString fileName() const;
 
     /**
      * Returns whether the transfer is suspendable.
      *
      * @return true if transfer is suspendable
      */
     bool isSuspendable() const;
 
     /**
      * Stops the current transfer.
      *
      * Possible errors: PendingCall::NotAuthorized, PendingCall::InProgress
      *                  PendingCall::Failed
      *
      * @return void pending call
      */
     PendingCall *cancel();
 
     /**
      * Suspends the current transfer.
      *
      * Only suspendable transfers can be suspended.
      *
      * Possible errors: PendingCall::NotAuthorized, PendingCall::NotInProgress
      *
      * @see isSuspendable() const
      *
      * @return void pending call
      */
     PendingCall *suspend();
 
     /**
      * Resumes the current transfer.
      *
      * Possible errors: PendingCall::NotAuthorized, PendingCall::NotInProgress
      *
      * @return void pending call
      */
     PendingCall *resume();
 
 Q_SIGNALS:
     /**
      * Indicates that the status of transfer have changed.
      */
     void statusChanged(Status status);
 
     /**
      * Indicates that the number of transferred bytes have changed.
      */
     void transferredChanged(quint64 transferred);
 
     /**
      * Indicates that the name of transferred file have changed.
      */
     void fileNameChanged(const QString &fileName);
 
 private:
     BLUEZQT_NO_EXPORT explicit ObexTransfer(const QString &path, const QVariantMap &properties);
 
     class ObexTransferPrivate *const d;
 
     friend class ObexTransferPrivate;
     friend class ObexAgentAdaptor;
     friend class PendingCallPrivate;
 };
 
 } // namespace BluezQt
 
 #endif // BLUEZQT_OBEXTRANSFER_H