/usr/include/threadweaver/State.h is in kdelibs5-dev 4:4.13.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 | /* -*- 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;
/** All weaver objects maintain a state of operation which can be
queried by the application. See the threadweaver documentation on
how the different states are related.
State is not part of the published API.
*/
enum StateId {
/** The object is in the state of construction and has not yet
started to process jobs. */
InConstruction = 0,
/** Jobs are being processed. */
WorkingHard,
/** Job processing is suspended, but some jobs which where already
in progress are not finished yet. */
Suspending,
/** Job processing is suspended, and no jobs are being
processed. */
Suspended,
/** The object is being destructed. Jobs might still be processed,
the destructor will wait for all threads to exit and then
end. */
ShuttingDown,
/** The object is being destructed, and all threads have
exited. No jobs are handled anymore. */
Destructed,
/** Not a state, but a sentinel for the number of defined states. */
NoOfStates
};
/** We use a State pattern to handle the system state in ThreadWeaver.
*/
class THREADWEAVER_EXPORT State
{
public:
/** Default constructor. */
explicit State( WeaverInterface *weaver );
/** Destructor. */
virtual ~State();
/** The ID of the current state.
@see StateNames, StateID
*/
QString stateName() const;
/** The state Id. */
virtual StateId stateId() const = 0;
/** Suspend job processing. */
virtual void suspend() = 0;
/** Resume job processing. */
virtual void resume() = 0;
/** Assign a job to an idle thread.
@param th the thread to give a new Job to
@param previous the job this thread finished before calling
* */
virtual Job* applyForWork ( Thread *th, Job* previous ) = 0;
/** Wait (by suspending the calling thread) until a job becomes available. */
virtual void waitForAvailableJob ( Thread *th ) = 0;
/** The state has been changed so that this object is responsible for
* state handling. */
virtual void activated();
protected:
/** The Weaver interface this state handles. */
WeaverInterface* weaver();
class Private;
Private * const d;
};
}
#endif // THREADWEAVER_STATE_H
|