dataslave.h

Go to the documentation of this file.

// -*- c++ -*-
/*
 *  This file is part of the KDE libraries
 *  Copyright (c) 2003 Leo Savernik <l.savernik@aon.at>
 *  Derived from slave.h
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License version 2 as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 **/

#ifndef KIO_DATASLAVE_H
#define KIO_DATASLAVE_H

#include "global.h"
#include "slave.h"

class QTimer;

// don't forget to sync DISPATCH_IMPL in dataslave.h
#define DISPATCH_DECL(type) \
    void dispatch_##type();

// don't forget to sync DISPATCH_IMPL1 in dataslave.h
#define DISPATCH_DECL1(type, paramtype, param) \
    void dispatch_##type(paramtype param);

namespace KIO {

    class DataSlave : public KIO::Slave {
    Q_OBJECT
    public:
    DataSlave();

        virtual ~DataSlave();

        virtual void setHost(const QString &host, quint16 port,
            const QString &user, const QString &passwd);
    virtual void setConfig(const MetaData &config);

        virtual void suspend();
        virtual void resume();
        virtual bool suspended();
        virtual void send(int cmd, const QByteArray &arr = QByteArray());

    virtual void hold(const KUrl &url);

    // pure virtual methods that are defined by the actual protocol
    virtual void get(const KUrl &url) = 0;
    virtual void mimetype(const KUrl &url) = 0;

    protected:
    void setAllMetaData(const MetaData &);
    void sendMetaData();

    // queuing methods
    enum QueueType { Queue_mimeType = 1, Queue_totalSize,
        Queue_sendMetaData, Queue_data, Queue_finished };
    struct QueueStruct {
      QueueType type;
      QString s;
      KIO::filesize_t size;
      QByteArray ba;

      QueueStruct() {}
      QueueStruct(QueueType type) : type(type) {}
    };
        typedef QList<QueueStruct> DispatchQueue;
    DispatchQueue dispatchQueue;

    DISPATCH_DECL1(mimeType, const QString &, s)
    DISPATCH_DECL1(totalSize, KIO::filesize_t, size)
    DISPATCH_DECL(sendMetaData)
    DISPATCH_DECL1(data, const QByteArray &, ba)
    DISPATCH_DECL(finished)

    protected Q_SLOTS:
    void dispatchNext();
    private:
    MetaData meta_data;
    bool _suspended;
    QTimer *timer;
    };

}

#undef DISPATCH_DECL
#undef DISPATCH_DECL1

#endif