transferdatasource.h

Go to the documentation of this file.

/* This file is part of the KDE project

   Copyright (C) 2008 Manolo Valdes <nolis71cu@gmail.com>

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
*/


#ifndef TRANSFERDATASOURCE_H
#define TRANSFERDATASOURCE_H

#include "kget_export.h"
#include "transfer.h"

#include <QObject>

#include <kio/job.h>

class KGET_EXPORT TransferDataSource : public QObject
{
    Q_OBJECT
    public:
        TransferDataSource(const KUrl &srcUrl, QObject *parent);
        virtual ~TransferDataSource();

        enum Error
        {
            Unknown,
            WrongDownloadSize,
            NotResumeable
        };

        Transfer::Capabilities capabilities() const;

        virtual void start() = 0;
        virtual void stop() = 0;

        virtual void findFileSize(KIO::fileoffset_t segmentSize);

        virtual void addSegments(const QPair<KIO::fileoffset_t, KIO::fileoffset_t> &segmentSize, const QPair<int, int> &segmentRange) = 0;

        virtual QPair<int, int> removeConnection();

        KUrl sourceUrl() const {return m_sourceUrl;}//TODO

        ulong currentSpeed() const {return m_speed;}

        virtual void setSupposedSize(KIO::filesize_t supposedSize) {m_supposedSize = supposedSize;}

        virtual QList<QPair<int, int> > assignedSegments() const;

        virtual int countUnfinishedSegments() const;

        virtual QPair<int, int> split();//TODO should split also take the current running segment into account?


        //the following methods are used for managing the number of paralell connections
        //subclasses have to keep track of the currentSegments
        virtual int paralellSegments() const;

        virtual void setParalellSegments(int paralellSegments);

        virtual int currentSegments() const;

        virtual int changeNeeded() const;

    signals:
        void foundFileSize(TransferDataSource *source, KIO::filesize_t fileSize, const QPair<int, int> &segmentRange);

        void capabilitiesChanged();

        void finishedDownload(TransferDataSource *source, KIO::filesize_t fileSize);

        void data(KIO::fileoffset_t offset, const QByteArray &data, bool &worked);

        void data(const QList<KUrl> &data);

        void data(const QString type, const QString checksum);

        void finished();

        void finishedSegment(TransferDataSource *source, int segmentNumber, bool connectionFinished = true);

        void broken(TransferDataSource *source, TransferDataSource::Error error);

        void brokenSegments(TransferDataSource *source, QPair<int, int> segmentRange);

        void speed(ulong speed);

        void freeSegments(TransferDataSource *source, QPair<int, int> segmentRange);

        void log(const QString &message, Transfer::LogLevel logLevel);
        
        void urlChanged(const KUrl &old, const KUrl &newUrl);

    protected:
        void setCapabilities(Transfer::Capabilities capabilities);

    private Q_SLOTS:
        virtual void slotSpeed(ulong speed) {Q_UNUSED(speed)}

    protected:
        KUrl m_sourceUrl;
        ulong m_speed;
        KIO::filesize_t m_supposedSize;
        int m_paralellSegments;
        int m_currentSegments;

    private:
        Transfer::Capabilities m_capabilities;
};
#endif