• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

ThreadWeaver

  • threadweaver
  • Weaver
WeaverInterface.h
Go to the documentation of this file.
1/* -*- C++ -*-
2
3 This file declares the WeaverInterface class.
4
5 $ Author: Mirko Boehm $
6 $ Copyright: (C) 2005-2013 Mirko Boehm $
7 $ Contact: mirko@kde.org
8 http://www.kde.org
9 http://creative-destruction.me $
10
11 This library is free software; you can redistribute it and/or
12 modify it under the terms of the GNU Library General Public
13 License as published by the Free Software Foundation; either
14 version 2 of the License, or (at your option) any later version.
15
16 This library is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Library General Public License for more details.
20
21 You should have received a copy of the GNU Library General Public License
22 along with this library; see the file COPYING.LIB. If not, write to
23 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 Boston, MA 02110-1301, USA.
25
26 $Id: WeaverImpl.h 29 2005-08-14 19:04:30Z mirko $
27*/
28
29#ifndef WeaverInterface_H
30#define WeaverInterface_H
31
32#include <QtCore/QObject>
33
34#include <threadweaver/threadweaver_export.h>
35
36namespace ThreadWeaver {
37
38class Job;
39class State;
40class WeaverObserver;
41
61class THREADWEAVER_EXPORT WeaverInterface : public QObject {
62 Q_OBJECT
63
64public:
68 explicit WeaverInterface ( QObject* parent = 0 );
69 virtual ~WeaverInterface() {}
71 virtual const State& state() const = 0;
72
74 virtual void setMaximumNumberOfThreads( int cap ) = 0;
75
77 virtual int maximumNumberOfThreads() const = 0;
78
80 virtual int currentNumberOfThreads () const = 0;
81
92 virtual void registerObserver ( WeaverObserver* ) = 0;
101 virtual void enqueue ( Job* ) = 0;
112 virtual bool dequeue ( Job* ) = 0;
116 virtual void dequeue () = 0;
127 virtual void finish () = 0;
137 virtual void suspend () = 0;
141 virtual void resume () = 0;
144 virtual bool isEmpty () const = 0;
148 virtual bool isIdle () const = 0;
154 virtual int queueLength () const = 0;
155
161 virtual void requestAbort() = 0;
162
163Q_SIGNALS:
170 void finished ();
171
176 void suspended ();
177
182 void jobDone ( ThreadWeaver::Job* );
183 // FIXME (0.7) test if signal is emitted properly
184 // FIXME (0.7) provide jobStarted and jobFailed signals
185 // FIXME (0.7) or remove all these, and add them to WeaverObserver
186
188 void stateChanged ( ThreadWeaver::State* );
189};
190
191}
192
193#endif
QObject
ThreadWeaver::Job
A Job is a simple abstraction of an action that is to be executed in a thread context.
Definition: Job.h:66
ThreadWeaver::State
We use a State pattern to handle the system state in ThreadWeaver.
Definition: State.h:74
ThreadWeaver::WeaverInterface
WeaverInterface provides a common interface for weaver implementations.
Definition: WeaverInterface.h:61
ThreadWeaver::WeaverInterface::resume
virtual void resume()=0
Resume job queueing.
ThreadWeaver::WeaverInterface::dequeue
virtual bool dequeue(Job *)=0
Remove a job from the queue.
ThreadWeaver::WeaverInterface::isEmpty
virtual bool isEmpty() const =0
Is the queue empty? The queue is empty if no more jobs are queued.
ThreadWeaver::WeaverInterface::requestAbort
virtual void requestAbort()=0
Request aborts of the currently executed jobs.
ThreadWeaver::WeaverInterface::suspend
virtual void suspend()=0
Suspend job execution.
ThreadWeaver::WeaverInterface::dequeue
virtual void dequeue()=0
Remove all queued jobs.
ThreadWeaver::WeaverInterface::enqueue
virtual void enqueue(Job *)=0
Add a job to be executed.
ThreadWeaver::WeaverInterface::currentNumberOfThreads
virtual int currentNumberOfThreads() const =0
Returns the current number of threads in the inventory.
ThreadWeaver::WeaverInterface::~WeaverInterface
virtual ~WeaverInterface()
Definition: WeaverInterface.h:69
ThreadWeaver::WeaverInterface::finished
void finished()
This signal is emitted when the Weaver has finished ALL currently queued jobs.
ThreadWeaver::WeaverInterface::finish
virtual void finish()=0
Finish all queued operations, then return.
ThreadWeaver::WeaverInterface::setMaximumNumberOfThreads
virtual void setMaximumNumberOfThreads(int cap)=0
Set the maximum number of threads this Weaver object may start.
ThreadWeaver::WeaverInterface::jobDone
void jobDone(ThreadWeaver::Job *)
This signal is emitted when a job is finished.
ThreadWeaver::WeaverInterface::state
virtual const State & state() const =0
Return the state of the weaver object.
ThreadWeaver::WeaverInterface::queueLength
virtual int queueLength() const =0
Returns the number of pending jobs.
ThreadWeaver::WeaverInterface::stateChanged
void stateChanged(ThreadWeaver::State *)
The Weaver's state has changed.
ThreadWeaver::WeaverInterface::registerObserver
virtual void registerObserver(WeaverObserver *)=0
Register an observer.
ThreadWeaver::WeaverInterface::suspended
void suspended()
Thread queueing has been suspended.
ThreadWeaver::WeaverInterface::maximumNumberOfThreads
virtual int maximumNumberOfThreads() const =0
Get the maximum number of threads this Weaver may start.
ThreadWeaver::WeaverInterface::isIdle
virtual bool isIdle() const =0
Is the weaver idle? The weaver is idle if no jobs are queued and no jobs are processed by the threads...
ThreadWeaver::WeaverObserver
Observers provides signals on some Weaver events that are otherwise only available through objects of...
Definition: WeaverObserver.h:59
ThreadWeaver
Definition: DebuggingAids.h:51
threadweaver_export.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

ThreadWeaver

Skip menu "ThreadWeaver"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal