Job.h

Go to the documentation of this file.

/* -*- C++ -*-

This file declares the Job class.

$ Author: Mirko Boehm $
$ Copyright: (C) 2004, 2005, 2006 Mirko Boehm $
$ Contact: mirko@kde.org
http://www.kde.org
http://www.hackerbuero.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.

$Id: Job.h 32 2005-08-17 08:38:01Z mirko $
*/

#ifndef THREADWEAVER_JOB_H
#define THREADWEAVER_JOB_H

#include <QtCore/QObject>

#include <threadweaver/threadweaver_export.h>

class QMutex;
class QWaitCondition;

namespace ThreadWeaver {

    class Thread;
    class QueuePolicy;
    class JobRunHelper;
    class WeaverInterface;
    class QueuePolicyList;

    class THREADWEAVER_EXPORT Job : public QObject
    {
        Q_OBJECT

    public:
        friend class JobRunHelper;

        explicit Job ( QObject* parent = 0 );

        virtual ~Job();

        virtual void execute(Thread*);

        virtual int priority() const;

        virtual bool success () const;

        // FIXME (Mirko) this should be private, I guess?
        virtual void requestAbort () {}

        virtual void aboutToBeQueued ( WeaverInterface *weaver );

        virtual void aboutToBeDequeued ( WeaverInterface *weaver );

        virtual bool canBeExecuted();

        bool isFinished() const;

        void assignQueuePolicy ( QueuePolicy* );

        void removeQueuePolicy ( QueuePolicy* );

    Q_SIGNALS:
    void started ( ThreadWeaver::Job* );
    void done ( ThreadWeaver::Job* );

        void failed( ThreadWeaver::Job* );

    protected:
        class Private;
        Private* d;

        void freeQueuePolicyResources();

        virtual void run () = 0;
        Thread *thread();

        void setFinished ( bool status );

        // QMutex& mutex();

    };
}

#endif // THREADWEAVER_JOB_H