State.h

Go to the documentation of this file.

/* -*- C++ -*-

   This file implements the state handling in ThreadWeaver.

   $ 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: State.h 32 2005-08-17 08:38:01Z mirko $
*/

#ifndef THREADWEAVER_STATE_H
#define THREADWEAVER_STATE_H



#include <threadweaver/threadweaver_export.h>

namespace ThreadWeaver {

    class Job;
    class Thread;
    class WeaverInterface;

    enum StateId {
        InConstruction = 0,
        WorkingHard,
        Suspending,
        Suspended,
        ShuttingDown,
        Destructed,
        NoOfStates
    };

    class THREADWEAVER_EXPORT State
    {
    public:
        explicit State( WeaverInterface *weaver );

        virtual ~State();

        QString stateName() const;
        virtual StateId stateId() const = 0;
        virtual void suspend() = 0;
        virtual void resume() = 0;
        virtual Job* applyForWork ( Thread *th,  Job* previous ) = 0;
        virtual void waitForAvailableJob ( Thread *th ) = 0;
        virtual void activated();

    protected:
        WeaverInterface* weaver();

        class Private;
        Private * const d;
    };
}

#endif // THREADWEAVER_STATE_H