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

Nepomuk-Core

  • sources
  • kde-4.12
  • kdelibs
  • nepomuk-core
  • services
  • fileindexer
indexingqueue.h
Go to the documentation of this file.
1 /*
2  <one line to give the library's name and an idea of what it does.>
3  Copyright (C) 2012 Vishesh Handa <me@vhanda.in>
4 
5  This library is free software; you can redistribute it and/or
6  modify it under the terms of the GNU Lesser General Public
7  License as published by the Free Software Foundation; either
8  version 2.1 of the License, or (at your option) any later version.
9 
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public
16  License along with this library; if not, write to the Free Software
17  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19 
20 
21 #ifndef FILEINDEXER_INDEXINGQUEUE_H
22 #define FILEINDEXER_INDEXINGQUEUE_H
23 
24 #include <QtCore/QObject>
25 #include <QtCore/QQueue>
26 #include <QtCore/QDirIterator>
27 #include <QtCore/QUrl>
28 
29 namespace Nepomuk2 {
30 
36  class IndexingQueue : public QObject
37  {
38  Q_OBJECT
39  public:
40  explicit IndexingQueue(QObject* parent = 0);
41 
42  virtual bool isEmpty() = 0;
43 
50  virtual void fillQueue();
51 
57  void setDelay( int msec );
58 
59  public slots:
60  void suspend();
61  void resume();
62 
63  signals:
68  void startedIndexing();
69 
74  void finishedIndexing();
75 
76  protected:
85  virtual void processNextIteration() = 0;
86 
87  protected slots:
94  void finishIteration();
95 
96  void callForNextIteration();
97 
98  private slots:
99  void processNext();
100 
101  private:
102  bool m_suspended;
103  bool m_sentEvent;
104  int m_delay;
105  };
106 
107 }
108 
109 
110 #endif // FILEINDEXER_INDEXINGQUEUE_H
Nepomuk2::IndexingQueue::IndexingQueue
IndexingQueue(QObject *parent=0)
Definition: indexingqueue.cpp:29
Nepomuk2::IndexingQueue::processNextIteration
virtual void processNextIteration()=0
Process the next iteration in your queue.
Nepomuk2::IndexingQueue::setDelay
void setDelay(int msec)
Sets a artificial delay between each call to processNextIteration.
Definition: indexingqueue.cpp:89
QObject
Nepomuk2::IndexingQueue::startedIndexing
void startedIndexing()
The derived queues must emit this signal when their queue gets filled up.
Nepomuk2::IndexingQueue::callForNextIteration
void callForNextIteration()
Definition: indexingqueue.cpp:64
Nepomuk2::IndexingQueue::suspend
void suspend()
Definition: indexingqueue.cpp:59
Nepomuk2::IndexingQueue::finishIteration
void finishIteration()
Call this function when you have finished processing the iteration from processNextIteration.
Definition: indexingqueue.cpp:81
Nepomuk2::IndexingQueue::finishedIndexing
void finishedIndexing()
Will automatically be emitted after an iteration if empty returns true.
Nepomuk2::IndexingQueue::isEmpty
virtual bool isEmpty()=0
Nepomuk2::IndexingQueue
An abstract class representing the queue.
Definition: indexingqueue.h:36
Nepomuk2::IndexingQueue::fillQueue
virtual void fillQueue()
fill the queue if there is available data, return true if something is enqueued.
Definition: indexingqueue.cpp:36
Nepomuk2::IndexingQueue::resume
void resume()
Definition: indexingqueue.cpp:51
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:48:08 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Nepomuk-Core

Skip menu "Nepomuk-Core"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs 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
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



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