ThreadWeaver::Thread Class Reference

#include <Thread.h>

Inheritance diagram for ThreadWeaver::Thread:

Signals
void	jobDone (ThreadWeaver::Job *)
void	jobStarted (ThreadWeaver::Thread *, ThreadWeaver::Job *)
void	started (ThreadWeaver::Thread *)

Public Member Functions
	Thread (WeaverImpl *parent=0)
	~Thread ()
unsigned int	id ()
void	msleep (unsigned long msec)
void	requestAbort ()
void	run ()
Public Member Functions inherited from QThread
	QThread (QObject *parent)
	~QThread ()
void	exit (int returnCode)
bool	finished () const
void	finished ()
bool	isFinished () const
bool	isRunning () const
Priority	priority () const
void	quit ()
bool	running () const
void	setPriority (Priority priority)
void	setStackSize (uint stackSize)
uint	stackSize () const
void	start (Priority priority)
void	started ()
void	terminate ()
void	terminated ()
bool	wait (unsigned long time)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QThread
QThread *	currentThread ()
Qt::HANDLE	currentThreadId ()
int	idealThreadCount ()
void	yieldCurrentThread ()
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QThread
int	exec ()
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QThread
void	msleep (unsigned long msecs)
void	setTerminationEnabled (bool enabled)
void	sleep (unsigned long secs)
void	usleep (unsigned long usecs)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

The class Thread is used to represent the worker threads in the weaver's inventory.

It is not meant to be overloaded.

Definition at line 46 of file Thread.h.

Constructor & Destructor Documentation

Thread::Thread ( WeaverImpl *  parent = 0 )

explicit

Create a thread.

These thread objects are only used inside the Weaver parent object.

@param parent the parent WeaverImpl

Definition at line 68 of file Thread.cpp.

Thread::~Thread

(

)

The destructor.

Definition at line 75 of file Thread.cpp.

Member Function Documentation

unsigned int Thread::id

(

)

Returns the thread id.

This id marks the respective Thread object, and must therefore not be confused with, e.g., the pthread thread ID.

Generally, the way threads are implemented is not specified. id() is the only way to uniquely identify a thread within ThreadWeaver.

Definition at line 80 of file Thread.cpp.

void ThreadWeaver::Thread::jobDone ( ThreadWeaver::Job *  )

signal

The thread finished to execute a job.

void ThreadWeaver::Thread::jobStarted ( ThreadWeaver::Thread *  , ThreadWeaver::Job *    )

signal

The thread started to process a job.

void Thread::msleep

(

unsigned long

msec

)

Provide the msleep() method (protected in QThread) to be available for executed jobs.

Parameters

msec	amount of milliseconds

Definition at line 115 of file Thread.cpp.

void Thread::requestAbort

(

)

Request the abortion of the current job.

If there is no current job, this method will do nothing, but can safely be called. It forwards the request to the current Job.

Definition at line 120 of file Thread.cpp.

void Thread::run ( )

virtual

Overload to execute the assigned jobs.

Whenever the thread is idle, it will ask its Weaver parent for a Job to do. The Weaver will either return a Job or a Nil pointer. When a Nil pointer is returned, it tells the thread to exit.

Reimplemented from QThread.

Definition at line 85 of file Thread.cpp.

void ThreadWeaver::Thread::started ( ThreadWeaver::Thread *  )

signal

The thread has been started.

---

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

• Thread.h
• Thread.cpp