Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QtConcurrent::ThreadEngineBase Class Referenceabstract

\inmodule QtConcurrent More...

#include <qtconcurrentthreadengine.h>

Inheritance diagram for QtConcurrent::ThreadEngineBase:
Collaboration diagram for QtConcurrent::ThreadEngineBase:

Public Member Functions

 ThreadEngineBase (QThreadPool *pool)
virtual ~ThreadEngineBase ()
void startSingleThreaded ()
void startThread ()
bool isCanceled ()
void waitForResume ()
bool isProgressReportingEnabled ()
void setProgressValue (int progress)
void setProgressRange (int minimum, int maximum)
void acquireBarrierSemaphore ()
void reportIfSuspensionDone () const
Public Member Functions inherited from QRunnable
constexpr QRunnable () noexcept=default
 Constructs a QRunnable.
virtual ~QRunnable ()
 QRunnable virtual destructor.
bool autoDelete () const
 Returns true is auto-deletion is enabled; false otherwise.
void setAutoDelete (bool autoDelete)
 Enables auto-deletion if autoDelete is true; otherwise auto-deletion is disabled.

Protected Member Functions

virtual void start ()
virtual void finish ()
virtual ThreadFunctionResult threadFunction ()
virtual bool shouldStartThread ()
virtual bool shouldThrottleThread ()

Protected Attributes

QFutureInterfaceBase * futureInterface
QThreadPool * threadPool
ThreadEngineBarrier barrier
QtPrivate::ExceptionStore exceptionStore
QBasicMutex mutex

Private Member Functions

void run () override
 Implement this pure virtual function in your subclass.
virtual void asynchronousFinish ()=0

Additional Inherited Members

Public Types inherited from QRunnable
template<typename Callable>
using if_callable = std::enable_if_t<std::is_invocable_r_v<void, Callable>, bool>
Static Public Member Functions inherited from QRunnable
template<typename Callable, if_callable< Callable > = true>
static QRunnable * create (Callable &&functionToRun)
static QRunnable * create (std::nullptr_t)=delete

Detailed Description

\inmodule QtConcurrent

Definition at line 51 of file qtconcurrentthreadengine.h.

Constructor & Destructor Documentation

◆ ThreadEngineBase()

QtConcurrent::ThreadEngineBase::ThreadEngineBase ( QThreadPool * pool)

Definition at line 132 of file qtconcurrentthreadengine.cpp.

◆ ~ThreadEngineBase()

QtConcurrent::ThreadEngineBase::~ThreadEngineBase ( )
virtual

Definition at line 138 of file qtconcurrentthreadengine.cpp.

Member Function Documentation

◆ acquireBarrierSemaphore()

void QtConcurrent::ThreadEngineBase::acquireBarrierSemaphore ( )

Definition at line 153 of file qtconcurrentthreadengine.cpp.

◆ asynchronousFinish()

virtual void QtConcurrent::ThreadEngineBase::asynchronousFinish ( )
privatepure virtual

Implemented in QtConcurrent::ThreadEngine< T >, QtConcurrent::ThreadEngine< QtPrivate::MapResultType< Iterator, MapFunctor > >, QtConcurrent::ThreadEngine< qValueType< Iterator >::value_type >, and QtConcurrent::ThreadEngine< void >.

◆ finish()

virtual void QtConcurrent::ThreadEngineBase::finish ( )
inlineprotectedvirtual

Reimplemented in QtConcurrent::FilteredReducedKernel< ReducedResultType, Iterator, KeepFunctor, ReduceFunctor, Reducer >, QtConcurrent::FilterKernel< Sequence, KeepFunctor, ReduceFunctor >, and QtConcurrent::MappedReducedKernel< ReducedResultType, Iterator, MapFunctor, ReduceFunctor, Reducer >.

Definition at line 69 of file qtconcurrentthreadengine.h.

◆ isCanceled()

bool QtConcurrent::ThreadEngineBase::isCanceled ( )

Definition at line 164 of file qtconcurrentthreadengine.cpp.

◆ isProgressReportingEnabled()

bool QtConcurrent::ThreadEngineBase::isProgressReportingEnabled ( )

Definition at line 178 of file qtconcurrentthreadengine.cpp.

◆ reportIfSuspensionDone()

void QtConcurrent::ThreadEngineBase::reportIfSuspensionDone ( ) const

Definition at line 158 of file qtconcurrentthreadengine.cpp.

◆ run()

void QtConcurrent::ThreadEngineBase::run ( )
overrideprivatevirtual

Implement this pure virtual function in your subclass.

Implements QRunnable.

Definition at line 232 of file qtconcurrentthreadengine.cpp.

◆ setProgressRange()

void QtConcurrent::ThreadEngineBase::setProgressRange ( int minimum,
int maximum )

Definition at line 190 of file qtconcurrentthreadengine.cpp.

◆ setProgressValue()

void QtConcurrent::ThreadEngineBase::setProgressValue ( int progress)

Definition at line 184 of file qtconcurrentthreadengine.cpp.

◆ shouldStartThread()

virtual bool QtConcurrent::ThreadEngineBase::shouldStartThread ( )
inlineprotectedvirtual

Reimplemented in QtConcurrent::FilteredReducedKernel< ReducedResultType, Iterator, KeepFunctor, ReduceFunctor, Reducer >, QtConcurrent::FilterKernel< Sequence, KeepFunctor, ReduceFunctor >, QtConcurrent::IterateKernel< Iterator, T >, QtConcurrent::IterateKernel< Iterator, QtPrivate::MapResultType< Iterator, MapFunctor > >, QtConcurrent::IterateKernel< Iterator, qValueType< Iterator >::value_type >, QtConcurrent::IterateKernel< Iterator, ReducedResultType >, QtConcurrent::IterateKernel< Iterator, void >, QtConcurrent::IterateKernel< Sequence::const_iterator, void >, QtConcurrent::IterateKernel< typename Sequence::const_iterator, void >, and QtConcurrent::MappedReducedKernel< ReducedResultType, Iterator, MapFunctor, ReduceFunctor, Reducer >.

Definition at line 71 of file qtconcurrentthreadengine.h.

◆ shouldThrottleThread()

virtual bool QtConcurrent::ThreadEngineBase::shouldThrottleThread ( )
inlineprotectedvirtual

Reimplemented in QtConcurrent::FilteredReducedKernel< ReducedResultType, Iterator, KeepFunctor, ReduceFunctor, Reducer >, QtConcurrent::FilterKernel< Sequence, KeepFunctor, ReduceFunctor >, and QtConcurrent::MappedReducedKernel< ReducedResultType, Iterator, MapFunctor, ReduceFunctor, Reducer >.

Definition at line 72 of file qtconcurrentthreadengine.h.

◆ start()

virtual void QtConcurrent::ThreadEngineBase::start ( )
inlineprotectedvirtual

Reimplemented in QtConcurrent::FilteredEachKernel< Iterator, KeepFunctor >, QtConcurrent::IterateKernel< Iterator, T >, QtConcurrent::IterateKernel< Iterator, QtPrivate::MapResultType< Iterator, MapFunctor > >, QtConcurrent::IterateKernel< Iterator, qValueType< Iterator >::value_type >, QtConcurrent::IterateKernel< Iterator, ReducedResultType >, QtConcurrent::IterateKernel< Iterator, void >, QtConcurrent::IterateKernel< Sequence::const_iterator, void >, and QtConcurrent::IterateKernel< typename Sequence::const_iterator, void >.

Definition at line 68 of file qtconcurrentthreadengine.h.

◆ startSingleThreaded()

void QtConcurrent::ThreadEngineBase::startSingleThreaded ( )

Definition at line 140 of file qtconcurrentthreadengine.cpp.

◆ startThread()

void QtConcurrent::ThreadEngineBase::startThread ( )

Definition at line 148 of file qtconcurrentthreadengine.cpp.

◆ threadFunction()

virtual ThreadFunctionResult QtConcurrent::ThreadEngineBase::threadFunction ( )
inlineprotectedvirtual

Reimplemented in QtConcurrent::IterateKernel< Iterator, T >, QtConcurrent::IterateKernel< Iterator, QtPrivate::MapResultType< Iterator, MapFunctor > >, QtConcurrent::IterateKernel< Iterator, qValueType< Iterator >::value_type >, QtConcurrent::IterateKernel< Iterator, ReducedResultType >, QtConcurrent::IterateKernel< Iterator, void >, QtConcurrent::IterateKernel< Sequence::const_iterator, void >, and QtConcurrent::IterateKernel< typename Sequence::const_iterator, void >.

Definition at line 70 of file qtconcurrentthreadengine.h.

◆ waitForResume()

void QtConcurrent::ThreadEngineBase::waitForResume ( )

Definition at line 172 of file qtconcurrentthreadengine.cpp.

Member Data Documentation

◆ barrier

ThreadEngineBarrier QtConcurrent::ThreadEngineBase::barrier
protected

Definition at line 91 of file qtconcurrentthreadengine.h.

◆ exceptionStore

QtPrivate::ExceptionStore QtConcurrent::ThreadEngineBase::exceptionStore
protected

Definition at line 92 of file qtconcurrentthreadengine.h.

◆ futureInterface

QFutureInterfaceBase* QtConcurrent::ThreadEngineBase::futureInterface
protected

Definition at line 89 of file qtconcurrentthreadengine.h.

◆ mutex

QBasicMutex QtConcurrent::ThreadEngineBase::mutex
protected

Definition at line 93 of file qtconcurrentthreadengine.h.

◆ threadPool

QThreadPool* QtConcurrent::ThreadEngineBase::threadPool
protected

Definition at line 90 of file qtconcurrentthreadengine.h.

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