WeaverInterface.h

Go to the documentation of this file.

/* -*- C++ -*-

   This file declares the WeaverInterface class.

   $ 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: WeaverImpl.h 29 2005-08-14 19:04:30Z mirko $
*/

#ifndef WeaverInterface_H
#define WeaverInterface_H

#include <QtCore/QObject>

#include <threadweaver/threadweaver_export.h>

namespace ThreadWeaver {

class Job;
class State;
class WeaverObserver;

class THREADWEAVER_EXPORT WeaverInterface : public QObject {
    Q_OBJECT

public:
    explicit WeaverInterface ( QObject* parent = 0 );
    virtual ~WeaverInterface() {}
    virtual const State& state() const = 0;

    virtual void setMaximumNumberOfThreads( int cap ) = 0;

    virtual int maximumNumberOfThreads() const = 0;

    virtual int currentNumberOfThreads () const = 0;

    virtual void registerObserver ( WeaverObserver* ) = 0;
    virtual void enqueue ( Job* ) = 0;
    virtual bool dequeue ( Job* ) = 0;
    virtual void dequeue () = 0;
    virtual void finish () = 0;
    virtual void suspend () = 0;
    virtual void resume () = 0;
    virtual bool isEmpty () const = 0;
    virtual bool isIdle () const = 0;
    virtual int queueLength () const = 0;

    virtual void requestAbort() = 0;

Q_SIGNALS:
    void finished ();

    void suspended ();

    void jobDone ( ThreadWeaver::Job* );
    // FIXME (0.7) test if signal is emitted properly
    // FIXME (0.7) provide jobStarted and jobFailed signals
    // FIXME (0.7) or remove all these, and add them to WeaverObserver

    void stateChanged ( ThreadWeaver::State* );
};

}

#endif