Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
QFutureInterfaceBasePrivate Class Reference

#include <qfutureinterface_p.h>

+ Collaboration diagram for QFutureInterfaceBasePrivate:

Classes

union  Data
 
struct  ProgressData
 
class  RefCount
 

Public Types

enum  ContinuationState : quint8 { Default , Canceled , Cleaned }
 

Public Member Functions

 QFutureInterfaceBasePrivate (QFutureInterfaceBase::State initialState)
 
 ~QFutureInterfaceBasePrivate ()
 
QThreadPool * pool () const
 
int internal_resultCount () const
 
bool internal_isResultReadyAt (int index) const
 
bool internal_waitForNextResult ()
 
bool internal_updateProgressValue (int progress)
 
bool internal_updateProgress (int progress, const QString &progressText=QString())
 
void internal_setThrottled (bool enable)
 
void sendCallOut (const QFutureCallOutEvent &callOut)
 
void sendCallOuts (const QFutureCallOutEvent &callOut1, const QFutureCallOutEvent &callOut2)
 
void connectOutputInterface (QFutureCallOutInterface *iface)
 
void disconnectOutputInterface (QFutureCallOutInterface *iface)
 
void setState (QFutureInterfaceBase::State state)
 

Public Attributes

QMutex m_mutex
 
QBasicMutex continuationMutex
 
QList< QFutureCallOutInterface * > outputConnections
 
QElapsedTimer progressTime
 
QWaitCondition waitCondition
 
QWaitCondition pausedWaitCondition
 
Data data = { QtPrivate::ResultStoreBase() }
 
QRunnable * runnable = nullptr
 
QThreadPool * m_pool = nullptr
 
std::function< void(const QFutureInterfaceBase &) continuation )
 
QFutureInterfaceBasePrivate * continuationData = nullptr
 
RefCount refCount = 1
 
QAtomicInt state
 
int m_progressValue = 0
 
QScopedPointer< ProgressData > m_progress
 
int m_expectedResultCount = 0
 
bool launchAsync = false
 
bool isValid = false
 
bool hasException = false
 
std::atomic< ContinuationState > continuationState { Default }
 

Detailed Description

Definition at line 84 of file qfutureinterface_p.h.

Member Enumeration Documentation

◆ ContinuationState

enum QFutureInterfaceBasePrivate::ContinuationState : quint8
Enumerator
Default 
Canceled 
Cleaned 

Definition at line 163 of file qfutureinterface_p.h.

Constructor & Destructor Documentation

◆ QFutureInterfaceBasePrivate()

QFutureInterfaceBasePrivate::QFutureInterfaceBasePrivate ( QFutureInterfaceBase::State initialState)

Definition at line 687 of file qfutureinterface.cpp.

References QElapsedTimer::invalidate(), and progressTime.

+ Here is the call graph for this function:

◆ ~QFutureInterfaceBasePrivate()

QFutureInterfaceBasePrivate::~QFutureInterfaceBasePrivate ( )

Definition at line 693 of file qfutureinterface.cpp.

References hasException.

Member Function Documentation

◆ connectOutputInterface()

void QFutureInterfaceBasePrivate::connectOutputInterface ( QFutureCallOutInterface * iface)

Definition at line 804 of file qfutureinterface.cpp.

References QList< T >::append(), QSet< T >::begin(), begin(), QFutureInterfaceBase::Canceled, QFutureCallOutEvent::Canceled, QSet< T >::end(), QFutureInterfaceBase::Finished, QFutureCallOutEvent::Finished, hasException, it, QBasicAtomicInteger< T >::loadRelaxed(), m_mutex, m_progress, m_progressValue, outputConnections, QFutureCallOutEvent::Progress, QFutureCallOutEvent::ProgressRange, QFutureCallOutEvent::ResultsReady, QFutureInterfaceBase::Started, QFutureCallOutEvent::Started, state, QFutureInterfaceBase::Suspended, QFutureCallOutEvent::Suspended, QFutureInterfaceBase::Suspending, and QFutureCallOutEvent::Suspending.

+ Here is the call graph for this function:

◆ disconnectOutputInterface()

void QFutureInterfaceBasePrivate::disconnectOutputInterface ( QFutureCallOutInterface * iface)

Definition at line 854 of file qfutureinterface.cpp.

References QListSpecialMethodsBase< T >::indexOf(), lock, m_mutex, outputConnections, and QList< T >::removeAt().

+ Here is the call graph for this function:

◆ internal_isResultReadyAt()

bool QFutureInterfaceBasePrivate::internal_isResultReadyAt ( int index) const

Definition at line 706 of file qfutureinterface.cpp.

References false, and hasException.

Referenced by QFutureInterfaceBase::isResultReadyAt(), and QFutureInterfaceBase::waitForResult().

+ Here is the caller graph for this function:

◆ internal_resultCount()

int QFutureInterfaceBasePrivate::internal_resultCount ( ) const

Definition at line 701 of file qfutureinterface.cpp.

References hasException.

Referenced by QFutureInterfaceBase::resultCount().

+ Here is the caller graph for this function:

◆ internal_setThrottled()

void QFutureInterfaceBasePrivate::internal_setThrottled ( bool enable)

Definition at line 762 of file qfutureinterface.cpp.

References QBasicAtomicInteger< T >::loadRelaxed(), pausedWaitCondition, state, switch_off(), switch_on(), QFutureInterfaceBase::Throttled, and QWaitCondition::wakeAll().

+ Here is the call graph for this function:

◆ internal_updateProgress()

bool QFutureInterfaceBasePrivate::internal_updateProgress ( int progress,
const QString & progressText = QString() )

Definition at line 743 of file qfutureinterface.cpp.

References QElapsedTimer::elapsed(), QElapsedTimer::isValid(), m_progress, m_progressValue, MaxProgressEmitsPerSecond, progressTime, Q_ASSERT, and QElapsedTimer::start().

Referenced by QFutureInterfaceBase::setProgressValueAndText().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ internal_updateProgressValue()

bool QFutureInterfaceBasePrivate::internal_updateProgressValue ( int progress)

Definition at line 727 of file qfutureinterface.cpp.

References QElapsedTimer::elapsed(), QElapsedTimer::isValid(), m_progressValue, MaxProgressEmitsPerSecond, progressTime, and QElapsedTimer::start().

Referenced by QFutureInterfaceBase::reportResultsReady().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ internal_waitForNextResult()

bool QFutureInterfaceBasePrivate::internal_waitForNextResult ( )

Definition at line 711 of file qfutureinterface.cpp.

References QFutureInterfaceBase::Canceled, hasException, QBasicAtomicInteger< T >::loadRelaxed(), m_mutex, QFutureInterfaceBase::Running, state, QWaitCondition::wait(), and waitCondition.

Referenced by QFutureInterfaceBase::waitForNextResult().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ pool()

QThreadPool * QFutureInterfaceBasePrivate::pool ( ) const
inline

Definition at line 166 of file qfutureinterface_p.h.

References QThreadPool::globalInstance(), and m_pool.

Referenced by QFutureInterfaceBase::suspendIfRequested(), QFutureInterfaceBase::waitForFinished(), QFutureInterfaceBase::waitForResult(), and QFutureInterfaceBase::waitForResume().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendCallOut()

void QFutureInterfaceBasePrivate::sendCallOut ( const QFutureCallOutEvent & callOut)

Definition at line 779 of file qfutureinterface.cpp.

References QList< T >::at(), i, QList< T >::isEmpty(), outputConnections, QFutureCallOutInterface::postCallOutEvent(), and QList< T >::size().

Referenced by QFutureInterfaceBase::cancel(), QFutureInterfaceBase::reportFinished(), QFutureInterfaceBase::reportResultsReady(), QFutureInterfaceBase::reportStarted(), QFutureInterfaceBase::reportSuspended(), QFutureInterfaceBase::setProgressRange(), QFutureInterfaceBase::setProgressValueAndText(), QFutureInterfaceBase::setSuspended(), QFutureInterfaceBase::suspendIfRequested(), and QFutureInterfaceBase::toggleSuspended().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendCallOuts()

void QFutureInterfaceBasePrivate::sendCallOuts ( const QFutureCallOutEvent & callOut1,
const QFutureCallOutEvent & callOut2 )

Definition at line 788 of file qfutureinterface.cpp.

References QList< T >::at(), i, QList< T >::isEmpty(), outputConnections, and QList< T >::size().

Referenced by QFutureInterfaceBase::reportResultsReady().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setState()

void QFutureInterfaceBasePrivate::setState ( QFutureInterfaceBase::State state)

Definition at line 865 of file qfutureinterface.cpp.

References newState(), state, and QBasicAtomicInteger< T >::storeRelaxed().

Referenced by QFutureInterfaceBase::reportStarted().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ continuation

std::function<void(const QFutureInterfaceBase &) QFutureInterfaceBasePrivate::continuation)

Definition at line 143 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::cleanContinuation(), QFutureInterfaceBase::runContinuation(), and QFutureInterfaceBase::setContinuation().

◆ continuationData

QFutureInterfaceBasePrivate* QFutureInterfaceBasePrivate::continuationData = nullptr

Definition at line 144 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::cancel(), QFutureInterfaceBase::cleanContinuation(), and QFutureInterfaceBase::setContinuation().

◆ continuationMutex

QBasicMutex QFutureInterfaceBasePrivate::continuationMutex

Definition at line 117 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::cleanContinuation(), QFutureInterfaceBase::runContinuation(), and QFutureInterfaceBase::setContinuation().

◆ continuationState

std::atomic<ContinuationState> QFutureInterfaceBasePrivate::continuationState { Default }

Definition at line 164 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::cleanContinuation(), QFutureInterfaceBase::isChainCanceled(), QFutureInterfaceBase::runContinuation(), and QFutureInterfaceBase::setContinuation().

◆ data

Data QFutureInterfaceBasePrivate::data = { QtPrivate::ResultStoreBase() }

Definition at line 138 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::exceptionStore(), QFutureInterfaceBase::resultStoreBase(), QFutureInterfaceBase::resultStoreBase(), QFutureInterfaceBase::waitForFinished(), and QFutureInterfaceBase::waitForResult().

◆ hasException

bool QFutureInterfaceBasePrivate::hasException = false

Definition at line 161 of file qfutureinterface_p.h.

Referenced by ~QFutureInterfaceBasePrivate(), connectOutputInterface(), QFutureInterfaceBase::exceptionStore(), QFutureInterfaceBase::hasException(), internal_isResultReadyAt(), internal_resultCount(), internal_waitForNextResult(), QFutureInterfaceBase::resultStoreBase(), QFutureInterfaceBase::resultStoreBase(), QFutureInterfaceBase::waitForFinished(), and QFutureInterfaceBase::waitForResult().

◆ isValid

bool QFutureInterfaceBasePrivate::isValid = false

Definition at line 160 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::cancel(), QFutureInterfaceBase::isValid(), QFutureInterfaceBase::reportStarted(), and QFutureInterfaceBase::reset().

◆ launchAsync

bool QFutureInterfaceBasePrivate::launchAsync = false

Definition at line 159 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::launchAsync(), and QFutureInterfaceBase::setLaunchAsync().

◆ m_expectedResultCount

int QFutureInterfaceBasePrivate::m_expectedResultCount = 0

Definition at line 158 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::expectedResultCount(), and QFutureInterfaceBase::setExpectedResultCount().

◆ m_mutex

QMutex QFutureInterfaceBasePrivate::m_mutex
mutable

Definition at line 116 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::cancel(), connectOutputInterface(), disconnectOutputInterface(), internal_waitForNextResult(), QFutureInterfaceBase::isProgressUpdateNeeded(), QFutureInterfaceBase::isResultReadyAt(), QFutureInterfaceBase::isValid(), QFutureInterfaceBase::mutex(), QFutureInterfaceBase::progressMaximum(), QFutureInterfaceBase::progressMinimum(), QFutureInterfaceBase::progressText(), QFutureInterfaceBase::progressValue(), QFutureInterfaceBase::reportFinished(), QFutureInterfaceBase::reportStarted(), QFutureInterfaceBase::reportSuspended(), QFutureInterfaceBase::resultCount(), QFutureInterfaceBase::setFilterMode(), QFutureInterfaceBase::setProgressRange(), QFutureInterfaceBase::setProgressValueAndText(), QFutureInterfaceBase::setSuspended(), QFutureInterfaceBase::setThrottled(), QFutureInterfaceBase::suspendIfRequested(), QFutureInterfaceBase::toggleSuspended(), QFutureInterfaceBase::waitForFinished(), QFutureInterfaceBase::waitForNextResult(), QFutureInterfaceBase::waitForResult(), and QFutureInterfaceBase::waitForResume().

◆ m_pool

QThreadPool* QFutureInterfaceBasePrivate::m_pool = nullptr

Definition at line 141 of file qfutureinterface_p.h.

Referenced by pool(), QFutureInterfaceBase::setThreadPool(), and QFutureInterfaceBase::threadPool().

◆ m_progress

QScopedPointer<ProgressData> QFutureInterfaceBasePrivate::m_progress

Definition at line 156 of file qfutureinterface_p.h.

Referenced by connectOutputInterface(), internal_updateProgress(), QFutureInterfaceBase::progressMaximum(), QFutureInterfaceBase::progressMinimum(), QFutureInterfaceBase::progressText(), QFutureInterfaceBase::reportResultsReady(), QFutureInterfaceBase::reset(), QFutureInterfaceBase::setExpectedResultCount(), QFutureInterfaceBase::setProgressRange(), and QFutureInterfaceBase::setProgressValueAndText().

◆ m_progressValue

int QFutureInterfaceBasePrivate::m_progressValue = 0

Definition at line 149 of file qfutureinterface_p.h.

Referenced by connectOutputInterface(), internal_updateProgress(), internal_updateProgressValue(), QFutureInterfaceBase::progressValue(), QFutureInterfaceBase::reportResultsReady(), QFutureInterfaceBase::reset(), QFutureInterfaceBase::setProgressRange(), and QFutureInterfaceBase::setProgressValueAndText().

◆ outputConnections

QList<QFutureCallOutInterface *> QFutureInterfaceBasePrivate::outputConnections

Definition at line 118 of file qfutureinterface_p.h.

Referenced by connectOutputInterface(), disconnectOutputInterface(), sendCallOut(), and sendCallOuts().

◆ pausedWaitCondition

QWaitCondition QFutureInterfaceBasePrivate::pausedWaitCondition

Definition at line 121 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::cancel(), internal_setThrottled(), QFutureInterfaceBase::setSuspended(), QFutureInterfaceBase::setThrottled(), QFutureInterfaceBase::suspendIfRequested(), QFutureInterfaceBase::toggleSuspended(), and QFutureInterfaceBase::waitForResume().

◆ progressTime

QElapsedTimer QFutureInterfaceBasePrivate::progressTime

Definition at line 119 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBasePrivate(), internal_updateProgress(), internal_updateProgressValue(), QFutureInterfaceBase::isProgressUpdateNeeded(), and QFutureInterfaceBase::reset().

◆ refCount

RefCount QFutureInterfaceBasePrivate::refCount = 1

Definition at line 146 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::QFutureInterfaceBase(), QFutureInterfaceBase::~QFutureInterfaceBase(), QFutureInterfaceBase::derefT(), and QFutureInterfaceBase::refT().

◆ runnable

QRunnable* QFutureInterfaceBasePrivate::runnable = nullptr

Definition at line 140 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::setRunnable(), QFutureInterfaceBase::waitForFinished(), and QFutureInterfaceBase::waitForResult().

◆ state

QAtomicInt QFutureInterfaceBasePrivate::state

Definition at line 147 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::cancel(), connectOutputInterface(), internal_setThrottled(), internal_waitForNextResult(), QFutureInterfaceBase::loadState(), QFutureInterfaceBase::queryState(), QFutureInterfaceBase::reportFinished(), QFutureInterfaceBase::reportResultsReady(), QFutureInterfaceBase::reportStarted(), QFutureInterfaceBase::reportSuspended(), QFutureInterfaceBase::setProgressValueAndText(), setState(), QFutureInterfaceBase::setSuspended(), QFutureInterfaceBase::setThrottled(), QFutureInterfaceBase::suspendIfRequested(), QFutureInterfaceBase::toggleSuspended(), and QFutureInterfaceBase::waitForResume().

◆ waitCondition

QWaitCondition QFutureInterfaceBasePrivate::waitCondition

Definition at line 120 of file qfutureinterface_p.h.

Referenced by QFutureInterfaceBase::cancel(), internal_waitForNextResult(), QFutureInterfaceBase::reportFinished(), QFutureInterfaceBase::reportResultsReady(), QFutureInterfaceBase::waitForFinished(), and QFutureInterfaceBase::waitForResult().

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