scheduler.h

Go to the documentation of this file.

// -*- c++ -*-
/* This file is part of the KDE libraries
    Copyright (C) 2000 Stephan Kulow <coolo@kde.org>
                       Waldo Bastian <bastian@kde.org>

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

    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_scheduler_h
#define _kio_scheduler_h

#include "kio/job.h"
#include "kio/jobclasses.h"
#include <QtCore/QTimer>
#include <QtCore/QMap>
#include <QtGui/QWidgetList>
#include <sys/types.h> // pid_t

namespace KIO {

    class Slave;
    class SlaveConfig;

    class SchedulerPrivate;
    class KIO_EXPORT Scheduler : public QObject
    {
        Q_OBJECT
        Q_CLASSINFO("D-Bus Interface", "org.kde.KIO.Scheduler")
    public:
        static void doJob(SimpleJob *job);

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED static void scheduleJob(SimpleJob *job);
#endif

        static void setJobPriority(SimpleJob *job, int priority);

        static void cancelJob(SimpleJob *job);

        static void jobFinished(KIO::SimpleJob *job, KIO::Slave *slave);

        static void putSlaveOnHold(KIO::SimpleJob *job, const KUrl &url);

        static void removeSlaveOnHold();

        static void publishSlaveOnHold();

        static KIO::Slave *getConnectedSlave(const KUrl &url,
                const KIO::MetaData &config = MetaData() );

        static bool assignJobToSlave(KIO::Slave *slave, KIO::SimpleJob *job);

        static bool disconnectSlave(KIO::Slave *slave);

        static void registerWindow(QWidget *wid);

        static void unregisterWindow(QObject *wid);

        // KDE5: those methods should probably be removed, ugly and only marginally useful
        static bool connect( const char *signal, const QObject *receiver,
                             const char *member);

        static bool connect( const QObject* sender, const char* signal,
                             const QObject* receiver, const char* member );

        static bool disconnect( const QObject* sender, const char* signal,
                                const QObject* receiver, const char* member );

        bool connect( const QObject *sender, const char *signal,
                      const char *member );

        static void checkSlaveOnHold(bool b);

        static void emitReparseSlaveConfiguration();

        static bool isSlaveOnHoldFor(const KUrl& url);

        static void updateInternalMetaData(SimpleJob* job);

    Q_SIGNALS:
        void slaveConnected(KIO::Slave *slave);
        void slaveError(KIO::Slave *slave, int error, const QString &errorMsg);

        // DBUS
        Q_SCRIPTABLE void reparseSlaveConfiguration(const QString &);
        Q_SCRIPTABLE void slaveOnHoldListChanged();

    private:
        Q_DISABLE_COPY(Scheduler)
        Scheduler();
        ~Scheduler();

        static Scheduler *self();

        Q_PRIVATE_SLOT(d_func(), void slotSlaveDied(KIO::Slave *slave))
        Q_PRIVATE_SLOT(d_func(), void slotSlaveStatus(pid_t pid, const QByteArray &protocol,
                                               const QString &host, bool connected))

        // connected to D-Bus signal:
        Q_PRIVATE_SLOT(d_func(), void slotReparseSlaveConfiguration(const QString &, const QDBusMessage&))
        Q_PRIVATE_SLOT(d_func(), void slotSlaveOnHoldListChanged())

        Q_PRIVATE_SLOT(d_func(), void slotSlaveConnected())
        Q_PRIVATE_SLOT(d_func(), void slotSlaveError(int error, const QString &errorMsg))
        Q_PRIVATE_SLOT(d_func(), void slotUnregisterWindow(QObject *))
    private:
        friend class SchedulerPrivate;
        SchedulerPrivate *const removeMe; // for BC only, KDE5: remove
        SchedulerPrivate *d_func();
};

}
#endif