kdelibs5-dev 4:4.14.38-0ubuntu3 / usr / include / threadweaver / ThreadWeaver.h

/* -*- 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;

/** The Weaver class provides the public implementation of the WeaverInterface.

        Weaver provides a static instance that can be used to perform jobs in
        threads without managing a weaver object. The static instance will
        only be created when it is first accessed. Also, Weaver objects will
        create the threads only when the first jobs are queued. Therefore, the
        creation of a Weaver object is a rather cheap operation.

        The WeaverImpl class provides two parts of API - one for the threads
        that are handled by it, and one for the ThreadWeaver users
        (application developers). To separate those two different API parts,
        Weaver only provides the interface supposed to be used by developers
        of multithreaded applications.

        Weaver creates and destroys WeaverImpl objects. It hides the
        implementation details of the WeaverImpl class. It is strongly
        discouraged to use the WeaverImpl class in programs, as its API will
        be changed without notice.
        Also, Weaver provides a factory method for this purpose that can be overloaded to create
        derived WeaverImpl objects.

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

    /** Destruct a Weaver object. */
    virtual ~Weaver ();

    const State& state() const;

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


    void registerObserver ( WeaverObserver* );

    /** Return the global Weaver instance.
        In some cases, a global Weaver object per application is
        sufficient for the applications purpose. If this is the case,
        query instance() to get a pointer to a global instance.
        If instance is never called, a global Weaver object will not be
        created.
    */
    // 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:
    /** The factory method to create the actual Weaver implementation.
    Overload this method to use a different or adapted implementation.
    */
    virtual WeaverInterface* makeWeaverImpl ();

private:

    class Private;
    Private* const d;
};
}

#endif // THREADWEAVER_H