ThreadWeaver::QueueSignals

Search for usage in LXR

ThreadWeaver::QueueSignals Class Reference

#include <queuesignals.h>

Inheritance diagram for ThreadWeaver::QueueSignals:

Signals

void finished ()
 
void stateChanged (ThreadWeaver::State *)
 
void suspended ()
 

Public Member Functions

 QueueSignals (QObject *parent=nullptr)
 
 QueueSignals (ThreadWeaver::Private::QueueSignals_Private *d, QObject *parent=nullptr)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from ThreadWeaver::QueueInterface
virtual int currentNumberOfThreads () const =0
 
virtual void dequeue ()=0
 
virtual bool dequeue (const JobPointer &job)=0
 
virtual void enqueue (const QVector< JobPointer > &jobs)=0
 
virtual void finish ()=0
 
virtual bool isEmpty () const =0
 
virtual bool isIdle () const =0
 
virtual int maximumNumberOfThreads () const =0
 
virtual int queueLength () const =0
 
virtual void requestAbort ()=0
 
virtual void reschedule ()=0
 
virtual void resume ()=0
 
virtual void setMaximumNumberOfThreads (int cap)=0
 
virtual void shutDown ()=0
 
virtual const Statestate () const =0
 
virtual void suspend ()=0
 

Protected Member Functions

ThreadWeaver::Private::QueueSignals_Private * d ()
 
const ThreadWeaver::Private::QueueSignals_Private * d () const
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
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)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

QueueSignals declares the Qt signals shared by the Queue and Weaver classes.

Definition at line 23 of file queuesignals.h.

Constructor & Destructor Documentation

◆ QueueSignals()

ThreadWeaver::QueueSignals::QueueSignals ( QObject parent = nullptr)
explicit

Construct a QueueSignals object, passing the QObject parent.

Definition at line 15 of file queuesignals.cpp.

Member Function Documentation

◆ finished

void ThreadWeaver::QueueSignals::finished ( )
signal

Emitted when the Queue has completed all jobs currently queued.

The Queue emits finished() when the job queue is empty, and the last job currently processed by a worker threads was completed. Beware that if multiple jobs are enqueued repeatedly one by one, this signal might be emitted multiple times, because the queued jobs where processed before new ones could be queued. To avoid this, queue all relevant jobs in a single operation, using for example a QueueStream or a Collection.

◆ stateChanged

void ThreadWeaver::QueueSignals::stateChanged ( ThreadWeaver::State )
signal

Emitted when the processing state of the Queue has changed.

◆ suspended

void ThreadWeaver::QueueSignals::suspended ( )
signal

The Queue has been suspended.

When the Queue is suspended, worker threads will not be assigned new jobs to process. Jobs waiting in the queue will not be started until processing is resumed. When suspend() is called, the worker threads will continue to process the job currently assigned to them. When the last thread finishes it's current assignment, suspended() is emitted.

See also
suspend()

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Dec 4 2022 04:06:48 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.