ThreadWeaver.h

Go to the documentation of this file.

/* -*- C++ -*-

   This file implements the public interfaces of the Weaver and the Job class.
   It should be the only include file necessary to use the ThreadWeaver
   library.

   $ Author: Mirko Boehm $
   $ Copyright: (C) 2005-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: ThreadWeaver.h 32 2005-08-17 08:38:01Z mirko $
*/
#ifndef THREADWEAVER_H
#define THREADWEAVER_H

#include <QtCore/QObject>
#include "WeaverInterface.h"

namespace ThreadWeaver {

class Job;
class State;
class WeaverObserver;

// Note: All member documentation is in the WeaverInterface class.
class THREADWEAVER_EXPORT Weaver : public WeaverInterface
{
    Q_OBJECT
public:
    explicit Weaver ( QObject* parent=0 );

    virtual ~Weaver ();

    const State& state() const;

    void setMaximumNumberOfThreads( int cap );
    int maximumNumberOfThreads() const;
    int currentNumberOfThreads () const;


    void registerObserver ( WeaverObserver* );

    // FIXME (0.7) this should be a WeaverInterface pointer
    static ThreadWeaver::Weaver* instance();
    virtual void enqueue (Job*);
    virtual bool dequeue (Job*);
    virtual void dequeue ();
    virtual void finish();
    virtual void suspend( );
    virtual void resume();
    bool isEmpty () const;
    bool isIdle () const;
    int queueLength () const;
    void requestAbort();

protected:
    virtual WeaverInterface* makeWeaverImpl ();

private:

    class Private;
    Private* const d;
};
}

#endif // THREADWEAVER_H