Nepomuk2::IndexingQueue Class Reference

#include <indexingqueue.h>

Inheritance diagram for Nepomuk2::IndexingQueue:

Public Slots
void	resume ()
void	suspend ()

Signals
void	finishedIndexing ()
void	startedIndexing ()

Public Member Functions
	IndexingQueue (QObject *parent=0)
virtual void	fillQueue ()
virtual bool	isEmpty ()=0
void	setDelay (int msec)

Protected Slots
void	callForNextIteration ()
void	finishIteration ()

Protected Member Functions
virtual void	processNextIteration ()=0

Detailed Description

An abstract class representing the queue.

All indexing queues should be derived from this queue.

Definition at line 36 of file indexingqueue.h.

Constructor & Destructor Documentation

Nepomuk2::IndexingQueue::IndexingQueue ( QObject *  parent = 0 )

explicit

Definition at line 29 of file indexingqueue.cpp.

Member Function Documentation

void Nepomuk2::IndexingQueue::callForNextIteration ( )

protectedslot

Definition at line 64 of file indexingqueue.cpp.

void Nepomuk2::IndexingQueue::fillQueue ( )

virtual

fill the queue if there is available data, return true if something is enqueued.

Should be used in combinition with isEmpty()

Default implementation will do nothing.

Reimplemented in Nepomuk2::FileIndexingQueue.

Definition at line 36 of file indexingqueue.cpp.

void Nepomuk2::IndexingQueue::finishedIndexing ( )

signal

Will automatically be emitted after an iteration if empty returns true.

void Nepomuk2::IndexingQueue::finishIteration ( )

protectedslot

Call this function when you have finished processing the iteration from processNextIteration.

See also

processNextIteration

Definition at line 81 of file indexingqueue.cpp.

virtual bool Nepomuk2::IndexingQueue::isEmpty ( )

pure virtual

Implemented in Nepomuk2::BasicIndexingQueue, and Nepomuk2::FileIndexingQueue.

virtual void Nepomuk2::IndexingQueue::processNextIteration ( )

protectedpure virtual

Process the next iteration in your queue.

Once you are done processing the file call finishIndexingFile so that the queue can continue processing and call this function when it is ready for the next iteration.

See also

finishIndexingFile

Implemented in Nepomuk2::BasicIndexingQueue, and Nepomuk2::FileIndexingQueue.

void Nepomuk2::IndexingQueue::resume ( )

slot

Definition at line 51 of file indexingqueue.cpp.

void Nepomuk2::IndexingQueue::setDelay

(

int

msec

)

Sets a artificial delay between each call to processNextIteration.

This can be used to slow down the indexing, in order to conserve resources.

Definition at line 89 of file indexingqueue.cpp.

void Nepomuk2::IndexingQueue::startedIndexing ( )

signal

The derived queues must emit this signal when their queue gets filled up.

void Nepomuk2::IndexingQueue::suspend ( )

slot

Definition at line 59 of file indexingqueue.cpp.

---

The documentation for this class was generated from the following files:

• indexingqueue.h
• indexingqueue.cpp