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

ThreadWeaver

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

Skip menu "kdelibs-4.10.5 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