src/base/bittorrent/torrentcontenthandler.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2022-2023  Vladimir Golovnev <glassez@yandex.ru>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #pragma once
  30
  31 #include <QObject>
  32
  33 #include "base/pathfwd.h"
  34 #include "abstractfilestorage.h"
  35 #include "downloadpriority.h"
  36
  37 namespace BitTorrent
  38 {
  39     class TorrentContentHandler : public QObject, public AbstractFileStorage
  40     {
  41     public:
  42         using QObject::QObject;
  43
  44         virtual bool hasMetadata() const = 0;
  45         virtual Path actualStorageLocation() const = 0;
  46         virtual Path actualFilePath(int fileIndex) const = 0;
  47         virtual QList<DownloadPriority> filePriorities() const = 0;
  48         virtual QList<qreal> filesProgress() const = 0;
  49         /**
  50          * @brief fraction of file pieces that are available at least from one peer
  51          *
  52          * This is not the same as torrrent availability, it is just a fraction of pieces
  53          * that can be downloaded right now. It varies between 0 to 1.
  54          */
  55         virtual QList<qreal> availableFileFractions() const = 0;
  56         virtual void fetchAvailableFileFractions(std::function<void (QList<qreal>)> resultHandler) const = 0;
  57
  58         virtual void prioritizeFiles(const QList<DownloadPriority> &priorities) = 0;
  59         virtual void flushCache() const = 0;
  60     };
  61 }