Base class for CWorker and CContinuousWorker. More...

Inheritance diagram for swift::misc::CWorkerBase:

Signals
void	aboutToStart ()
	Emitted when the task is about to start.

void	finished ()
	Emitted when the task is finished. More...

Public Member Functions
	~CWorkerBase ()
	Destructor.

	CWorkerBase (const CWorkerBase &)=delete
	Copy constructor.

CWorkerBase &	operator= (const CWorkerBase &)=delete
	Copy assignment.

	CWorkerBase (CWorkerBase &&)=delete
	Move constructor.

CWorkerBase &	operator= (CWorkerBase &&)=delete
	Move assignment.

template<typename T , typename F >
void	then (T *context, F functor)
	Connects to a functor or method which will be called when the task is finished. More...

template<typename F >
void	then (F functor)
	Connects to a functor which will be called when the task is finished. More...

bool	isFinished () const
	Returns true if the task has finished. More...

template<typename F >
void	doIfFinished (F functor) const
	Executes some code (in the caller's thread) if the task has finished. More...

template<typename F >
void	doIfNotFinished (F functor) const
	Executes some code (in the caller's thread) if the task has not finished. More...

template<typename F1 , typename F2 >
void	doIfFinishedElse (F1 ifFunctor, F2 elseFunctor) const
	Executes some code (in the caller's thread) if the task has finished and some different code if it has not finished. More...

void	waitForFinished () noexcept
	Blocks until the task is finished. More...

void	abandon () noexcept
	Notify the task that its result is no longer needed, so it can finish early. More...

void	abandonAndWait () noexcept
	Convenience to call abandon() followed by waitForFinished().

Public Member Functions inherited from QObject
QBindable< QString >	bindableObjectName ()

	QObject (QObject *parent)

	QT_NO_CONTEXTLESS_CONNECT QT_NO_CONTEXTLESS_CONNECT

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUMS (...)

	Q_ENUM_NS (...)

	Q_FLAG (...)

	Q_FLAGS (...)

	Q_FLAG_NS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

bool	blockSignals (bool block)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

bool	moveToThread (QThread *targetThread)

bool	setProperty (const char *name, QVariant &&value)

bool	setProperty (const char *name, const QVariant &value)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::nanoseconds interval, Qt::TimerType timerType)

void	deleteLater ()

void	destroyed (QObject *obj)

void	installEventFilter (QObject *filterObj)

void	killTimer (Qt::TimerId id)

void	killTimer (int id)

void	objectNameChanged (const QString &objectName)

void	removeEventFilter (QObject *obj)

void	setObjectName (QAnyStringView name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

QList< QByteArray >	dynamicPropertyNames () const const

QList< T >	findChildren (QAnyStringView name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

QObject *	parent () const const

QString	objectName () const const

QThread *	thread () const const

QVariant	property (const char *name) const const

T	findChild (QAnyStringView name, Qt::FindChildOptions options) const const

T	findChild (Qt::FindChildOptions options) const const

bool	disconnect (const QObject receiver, const char method) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	inherits (const char *className) const const

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

virtual const QMetaObject *	metaObject () const const

const QObjectList &	children () const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

Static Public Member Functions
static const QStringList &	getLogCategories ()
	Log categories.

static const QSet< CWorkerBase * > &	allWorkers ()
	All workers currently existing.

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

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, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QString	tr (const char sourceText, const char disambiguation, int n)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

Protected Member Functions
	CWorkerBase ()
	Constructor.

bool	isAbandoned () const
	For the task to check whether it can finish early. More...

bool	hasStarted () const
	True if the worker has started.

void	setStarted ()
	Mark the task as started.

void	setFinished ()
	Mark the task as finished.

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)

virtual void	timerEvent (QTimerEvent *event)

QObject *	sender () const const

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

int	senderSignalIndex () const const

Additional Inherited Members
Public Types inherited from QObject
enum	TimerId

Public Attributes inherited from QObject
typedef	QObjectList

	Invalid

Properties inherited from QObject
	objectName

Detailed Description

Base class for CWorker and CContinuousWorker.

Definition at line 71 of file worker.h.

Member Function Documentation

◆ abandon()

void swift::misc::CWorkerBase::abandon ( )

noexcept

Notify the task that its result is no longer needed, so it can finish early.

Remarks: This function is thread safe.

Definition at line 141 of file worker.cpp.

◆ doIfFinished()

template<typename F >

void swift::misc::CWorkerBase::doIfFinished ( F functor ) const

inline

Executes some code (in the caller's thread) if the task has finished.

Remarks: This function is thread safe. The functor may not call any method that observes the worker's finished flag.

Definition at line 126 of file worker.h.

◆ doIfFinishedElse()

template<typename F1 , typename F2 >

void swift::misc::CWorkerBase::doIfFinishedElse	(	F1	ifFunctor,
		F2	elseFunctor
	)		const

inline

Executes some code (in the caller's thread) if the task has finished and some different code if it has not finished.

Remarks: This function is thread safe. The functor may not call any method that observes the worker's finished flag.

Definition at line 144 of file worker.h.

◆ doIfNotFinished()

template<typename F >

void swift::misc::CWorkerBase::doIfNotFinished ( F functor ) const

inline

Executes some code (in the caller's thread) if the task has not finished.

Remarks: This function is thread safe. The functors may not call any methods that observe the worker's finished flag.

Definition at line 135 of file worker.h.

◆ finished

void swift::misc::CWorkerBase::finished ( )

signal

Emitted when the task is finished.

Note: Slots connected to this signal may not call any methods that observe the worker's finished flag.

◆ isAbandoned()

bool swift::misc::CWorkerBase::isAbandoned ( ) const

protected

For the task to check whether it can finish early.

Remarks: This function is thread safe.

Definition at line 153 of file worker.cpp.

◆ isFinished()

bool swift::misc::CWorkerBase::isFinished ( ) const

inline

Returns true if the task has finished.

Remarks: This function is thread safe. But don't rely on this condition remaining true for any length of time.

Definition at line 117 of file worker.h.

◆ then() [1/2]

template<typename F >

void swift::misc::CWorkerBase::then ( F functor )

inline

Connects to a functor which will be called when the task is finished.

Remarks: This function is thread safe. The functor may not call any method that observes the worker's finished flag.

Definition at line 108 of file worker.h.

◆ then() [2/2]

template<typename T , typename F >

void swift::misc::CWorkerBase::then	(	T *	context,
		F	functor
	)

inline

Connects to a functor or method which will be called when the task is finished.

Remarks: This function is thread safe. The functor may not call any method that observes the worker's finished flag.

Definition at line 97 of file worker.h.

◆ waitForFinished()

void swift::misc::CWorkerBase::waitForFinished ( )

noexcept

Blocks until the task is finished.

Remarks: This function is thread safe. Will deadlock if called by the worker thread.

Definition at line 134 of file worker.cpp.

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

src/misc/worker.h
src/misc/worker.cpp

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ abandon()

◆ doIfFinished()

◆ doIfFinishedElse()

◆ doIfNotFinished()

◆ finished

◆ isAbandoned()

◆ isFinished()

◆ then() [1/2]

◆ then() [2/2]

◆ waitForFinished()