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

ThreadWeaver

  • threadweaver
  • Weaver
ThreadWeaver.cpp
Go to the documentation of this file.
1/* -*- C++ -*-
2
3This file implements the Weaver class.
4
5$ Author: Mirko Boehm $
6$ Copyright: (C) 2005-2013 Mirko Boehm $
7$ Contact: mirko@kde.org
8http://www.kde.org
9http://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: ThreadWeaver.cpp 30 2005-08-16 16:16:04Z mirko $
27*/
28
29#include "ThreadWeaver.h"
30
31#include <QtCore/QMutex>
32
33#include "WeaverImpl.h"
34#include "WeaverObserver.h"
35
36using namespace ThreadWeaver;
37
38class Weaver::Private
39{
40public:
41 Private ()
42 : implementation(0)
43 {}
44
45 WeaverInterface* implementation;
46};
47
48Weaver::Weaver ( QObject* parent )
49 : WeaverInterface( parent )
50 , d (new Private)
51{
52 d->implementation = makeWeaverImpl();
53 connect ( d->implementation, SIGNAL (finished()), SIGNAL (finished()) );
54 connect ( d->implementation, SIGNAL (suspended()), SIGNAL (suspended()) );
55 connect ( d->implementation, SIGNAL (jobDone(ThreadWeaver::Job*)),
56 SIGNAL (jobDone(ThreadWeaver::Job*)) );
57}
58
59Weaver::~Weaver()
60{
61 delete d->implementation;
62 delete d;
63}
64
65WeaverInterface* Weaver::makeWeaverImpl()
66{
67 return new WeaverImpl ( this );
68}
69
70const State& Weaver::state() const
71{
72 return d->implementation->state();
73}
74
75void Weaver::registerObserver ( WeaverObserver *ext )
76{
77 d->implementation->registerObserver ( ext );
78}
79
80Weaver* Weaver::instance()
81{
86 static Weaver* s_instance;
87
88 static QMutex mutex;
89 QMutexLocker l(&mutex);
90 if ( s_instance == 0 )
91 {
92 s_instance = new Weaver();
93 }
94 return s_instance;
95}
96
97void Weaver::enqueue (Job* j)
98{
99 d->implementation->enqueue ( j );
100}
101
102bool Weaver::dequeue (Job* j)
103{
104 return d->implementation->dequeue ( j );
105}
106
107void Weaver::dequeue ()
108{
109 return d->implementation->dequeue();
110}
111
112void Weaver::finish ()
113{
114 return d->implementation->finish ();
115}
116
117void Weaver::suspend ()
118{
119 return d->implementation->suspend();
120}
121
122void Weaver::resume ()
123{
124 return d->implementation->resume();
125}
126
127bool Weaver::isEmpty() const
128{
129 return d->implementation->isEmpty();
130}
131
132bool Weaver::isIdle() const
133{
134 return d->implementation->isIdle();
135}
136
137int Weaver::queueLength() const
138{
139 return d->implementation->queueLength();
140}
141
142void Weaver::setMaximumNumberOfThreads( int cap )
143{
144 d->implementation->setMaximumNumberOfThreads( cap );
145}
146
147int Weaver::currentNumberOfThreads() const
148{
149 return d->implementation->currentNumberOfThreads();
150}
151
152int Weaver::maximumNumberOfThreads() const
153{
154 return d->implementation->maximumNumberOfThreads();
155}
156
157void Weaver::requestAbort()
158{
159 d->implementation->requestAbort();
160}
161
162#include "ThreadWeaver.moc"
ThreadWeaver.h
WeaverImpl.h
WeaverObserver.h
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::WeaverImpl
A WeaverImpl is the manager of worker threads (Thread objects) to which it assigns jobs from its queu...
Definition: WeaverImpl.h:52
ThreadWeaver::WeaverInterface
WeaverInterface provides a common interface for weaver implementations.
Definition: WeaverInterface.h:61
ThreadWeaver::WeaverInterface::finished
void finished()
This signal is emitted when the Weaver has finished ALL currently queued jobs.
ThreadWeaver::WeaverInterface::jobDone
void jobDone(ThreadWeaver::Job *)
This signal is emitted when a job is finished.
ThreadWeaver::WeaverInterface::suspended
void suspended()
Thread queueing has been suspended.
ThreadWeaver::WeaverObserver
Observers provides signals on some Weaver events that are otherwise only available through objects of...
Definition: WeaverObserver.h:59
ThreadWeaver::Weaver
The Weaver class provides the public implementation of the WeaverInterface.
Definition: ThreadWeaver.h:66
ThreadWeaver::Weaver::makeWeaverImpl
virtual WeaverInterface * makeWeaverImpl()
The factory method to create the actual Weaver implementation.
Definition: ThreadWeaver.cpp:65
ThreadWeaver::Weaver::dequeue
virtual void dequeue()
Remove all queued jobs.
Definition: ThreadWeaver.cpp:107
ThreadWeaver::Weaver::instance
static ThreadWeaver::Weaver * instance()
Return the global Weaver instance.
Definition: ThreadWeaver.cpp:80
ThreadWeaver::Weaver::requestAbort
void requestAbort()
Request aborts of the currently executed jobs.
Definition: ThreadWeaver.cpp:157
ThreadWeaver::Weaver::registerObserver
void registerObserver(WeaverObserver *)
Register an observer.
Definition: ThreadWeaver.cpp:75
ThreadWeaver::Weaver::enqueue
virtual void enqueue(Job *)
Add a job to be executed.
Definition: ThreadWeaver.cpp:97
ThreadWeaver::Weaver::setMaximumNumberOfThreads
void setMaximumNumberOfThreads(int cap)
Set the maximum number of threads this Weaver object may start.
Definition: ThreadWeaver.cpp:142
ThreadWeaver::Weaver::queueLength
int queueLength() const
Returns the number of pending jobs.
Definition: ThreadWeaver.cpp:137
ThreadWeaver::Weaver::isIdle
bool isIdle() const
Is the weaver idle? The weaver is idle if no jobs are queued and no jobs are processed by the threads...
Definition: ThreadWeaver.cpp:132
ThreadWeaver::Weaver::finish
virtual void finish()
Finish all queued operations, then return.
Definition: ThreadWeaver.cpp:112
ThreadWeaver::Weaver::isEmpty
bool isEmpty() const
Is the queue empty? The queue is empty if no more jobs are queued.
Definition: ThreadWeaver.cpp:127
ThreadWeaver::Weaver::maximumNumberOfThreads
int maximumNumberOfThreads() const
Get the maximum number of threads this Weaver may start.
Definition: ThreadWeaver.cpp:152
ThreadWeaver::Weaver::state
const State & state() const
Return the state of the weaver object.
Definition: ThreadWeaver.cpp:70
ThreadWeaver::Weaver::currentNumberOfThreads
int currentNumberOfThreads() const
Returns the current number of threads in the inventory.
Definition: ThreadWeaver.cpp:147
ThreadWeaver::Weaver::Weaver
Weaver(QObject *parent=0)
Construct a Weaver object.
Definition: ThreadWeaver.cpp:48
ThreadWeaver::Weaver::suspend
virtual void suspend()
Suspend job execution.
Definition: ThreadWeaver.cpp:117
ThreadWeaver::Weaver::~Weaver
virtual ~Weaver()
Destruct a Weaver object.
Definition: ThreadWeaver.cpp:59
ThreadWeaver::Weaver::resume
virtual void resume()
Resume job queueing.
Definition: ThreadWeaver.cpp:122
ThreadWeaver
Definition: DebuggingAids.h:51
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