idownload.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/
 
#pragma once
 
#include <QUrl>
#include <QtPlugin>
#include <util/sll/eitherfwd.h>
#include "structures.h"
 
template<typename>
class QFuture;
 
struct EntityTestHandleResult;

class Q_DECL_EXPORT IDownload
{
public:
    struct Error
    {
        enum class Type
        {
            Unknown,
            NoError,
            NotFound,
            Gone,
            AccessDenied,
            AuthRequired,
            ProtocolError,
            NetworkError,
            ContentError,
            ProxyError,
            ServerError,
            LocalError,
            UserCanceled
        } Type_;
 
        QString Message_;
 
        bool operator== (const Error& other) const
        {
            return Type_ == other.Type_ && Message_ == other.Message_;
        }
    };
 
    struct Success {};
 
    using Result = LC::Util::Either<Error, Success>;

    virtual qint64 GetDownloadSpeed () const = 0;
    virtual qint64 GetUploadSpeed () const = 0;

    virtual EntityTestHandleResult CouldDownload (const LC::Entity& entity) const = 0;

    virtual QFuture<Result> AddJob (LC::Entity entity) = 0;

    virtual ~IDownload () {}
};
 
Q_DECLARE_INTERFACE (IDownload, "org.Deviant.LeechCraft.IDownload/1.0")
 
Q_DECLARE_METATYPE (QList<QUrl>)