JobCollection.h

Go to the documentation of this file.

/* -*- C++ -*-

   This file declares the JobCollection class.

   $ Author: Mirko Boehm $
   $ Copyright: (C) 2004-2013 Mirko Boehm $
   $ Contact: mirko@kde.org
         http://www.kde.org
         http://creative-destruction.me $

   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: DebuggingAids.h 30 2005-08-16 16:16:04Z mirko $
*/

#ifndef JOBCOLLECTION_H
#define JOBCOLLECTION_H

#include "Job.h"

namespace ThreadWeaver {

    class Thread;
    class JobCollectionJobRunner;

    class THREADWEAVER_EXPORT JobCollection : public Job
    {
        friend class JobCollectionJobRunner;
        Q_OBJECT

    public:
        explicit JobCollection ( QObject *parent = 0 );
        ~JobCollection ();
        virtual void addJob ( Job* );

        bool canBeExecuted();

    public Q_SLOTS:
        void stop ( ThreadWeaver::Job *job );

    protected:
        void aboutToBeQueued ( WeaverInterface *weaver );

        void aboutToBeDequeued ( WeaverInterface *weaver );

        Job* jobAt( int i );

#ifdef __GNUC__
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 1)
#pragma GCC diagnostic ignored "-Wignored-qualifiers"
#endif
#endif

        const int jobListLength(); // const qualifier is possibly BiC?

        virtual void internalJobDone( Job* );

        void finalCleanup();

    private Q_SLOTS:
        // called when an internal job runner emits its done(Job*) signal.
        // JobCollection emits done(Job*) after the last JobCollectionJobRunner finishes
        void jobRunnerDone();

    private:
        void execute ( Thread * );

        void run() {}

        void dequeueElements();

      class Private;
      Private * const d;

    };

}

#endif