itransfermanager.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 <variant>
#include <QObject>
#include <QString>
 
namespace LC::Azoth::Emitters
{
    class TransferJob;
    class TransferManager;
}
 
namespace LC::Azoth
{
    namespace Transfers
    {
        enum class Phase : std::uint8_t
        {
            Starting,
            Transferring,
            Finished
        };
 
        enum class ErrorReason : std::uint8_t
        {
            Aborted,
            FileInaccessible,
            FileCorrupted,
            ProtocolError,
        };
 
        struct Error
        {
            ErrorReason Reason_;
            QString Message_ {};
 
            bool operator== (const Error&) const = default;
        };
    }
 
    using TransferState = std::variant<
            Transfers::Phase,
            Transfers::Error
        >;
 
    inline bool IsTerminal (const TransferState& state)
    {
        return std::holds_alternative<Transfers::Error> (state) || state == TransferState { Transfers::Phase::Finished };
    }

    class ITransferJob
    {
    public:
        virtual ~ITransferJob () = default;
 
        virtual Emitters::TransferJob& GetTransferJobEmitter () = 0;

        virtual void Abort () = 0;
    };
 
    class ITransferManager;
 
    struct IncomingOffer
    {
        ITransferManager *Manager_;
        uint64_t JobId_;
 
        QString EntryId_;
 
        QString Name_;
        qsizetype Size_;
 
        QString Description_ {};
 
        bool operator== (const IncomingOffer& other) const = default;
    };

    class ITransferManager
    {
    public:
        virtual ~ITransferManager () = default;
 
        virtual Emitters::TransferManager& GetTransferManagerEmitter () = 0;

        virtual bool IsAvailable () const = 0;
 
        virtual ITransferJob* Accept (const IncomingOffer& offer, const QString& savePath) = 0;
 
        virtual void Decline (const IncomingOffer&) = 0;

        virtual ITransferJob* SendFile (const QString& id,
                const QString& variant,
                const QString& path,
                const QString& comment) = 0;
    };
}
 
Q_DECLARE_INTERFACE (LC::Azoth::ITransferJob, "org.Deviant.LeechCraft.Azoth.ITransferJob/1.0")
Q_DECLARE_INTERFACE (LC::Azoth::ITransferManager, "org.Deviant.LeechCraft.Azoth.ITransferManager/1.0")