/usr/include/threadweaver/QueuePolicy.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 | /* -*- C++ -*-
This file declares the QueuePolicy class.
$ Author: Mirko Boehm $
$ Copyright: (C) 2004, 2005, 2006 Mirko Boehm $
$ Contact: mirko@kde.org
http://www.kde.org
http://www.hackerbuero.org $
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: DebuggingAids.h 30 2005-08-16 16:16:04Z mirko $
*/
#ifndef QUEUEPOLICY_H
#define QUEUEPOLICY_H
#include <threadweaver/threadweaver_export.h>
namespace ThreadWeaver {
class Job;
/** QueuePolicy is an interface for customizations of the queueing behaviour
of sets of jobs.
A job can have a queueing policy assigned. In that case, the job is only
executed when the method canRun() of the assigned policy returns true. For
every call to canRun() that returns true, it is guaranteed that the method
free() or the method release() is called. Calling free() means the job has
been executed, while calling release() means the job was not executed for
external reasons, and will be retried later on.
As an example, dependencies can be implemented using a QueuePolicy:
canRun() returns true when the job has no unresolved dependencies. free()
and release() are empty.
A job can have multiple queue policies assigned, and will only be executed
if all of them return true from canRun() within the same execution attempt.
Jobs only keep a reference to the QueuePolicy. Therefore, the same object
can be assigned to multiple jobs and this way control the way all those
jobs are executed. Jobs never assume ownership of their assigned queue
policies.
*/
class THREADWEAVER_EXPORT QueuePolicy
{
public:
virtual ~QueuePolicy() {}
/** canRun() is called before the job is executed.
The job will only be executed if canRun() returns true.
*/
virtual bool canRun( Job* ) = 0;
/** free() is called after the job has been executed.
It is guaranteed that free is called only after canRun()
returned true at an earlier time.
*/
virtual void free( Job* ) = 0;
/** release() is called if canRun() returned true, but the job has not
been executed for external reasons. For example, a second
QueuePolicy could have returned false from canRun() for the same
job.
*/
virtual void release( Job* ) = 0;
/** destructing() is called when a Job that has this queue policy
assigned gets destructed.
*/
virtual void destructed ( Job* ) = 0;
};
}
#endif
|