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
QFutureInterface< T > Class Template Reference

#include <qfutureinterface.h>

Inheritance diagram for QFutureInterface< T >:
Collaboration diagram for QFutureInterface< T >:

Public Member Functions

 QFutureInterface (State initialState=NoState)
 QFutureInterface (const QFutureInterface &other)
 QFutureInterface (const QFutureInterfaceBase &dd)
 QFutureInterface (QFutureInterfaceBase &&dd) noexcept
QFutureInterface & operator= (const QFutureInterface &other)
 QFutureInterface (QFutureInterface &&other)=default
 ~QFutureInterface ()
QFuture< T > future ()
template<typename... Args, std::enable_if_t< std::is_constructible_v< T, Args... >, bool > = true>
bool reportAndEmplaceResult (int indexindex, Args &&...args)
bool reportResult (const T *resultresult, int indexindex=-1)
bool reportAndMoveResult (T &&resultresult, int indexindex=-1)
bool reportResult (T &&resultresult, int indexindex=-1)
bool reportResult (const T &resultresult, int indexindex=-1)
bool reportResults (const QList< T > &results, int beginIndex=-1, int countcount=-1)
bool reportFinished (const T *resultresult)
void reportFinished ()
const T & resultReference (int indexindex) const
const T * resultPointer (int indexindex) const
QList< T > results ()
T takeResult ()
void reportException (const std::exception_ptr &e)
void reportException (const QException &e)
Public Member Functions inherited from QFutureInterfaceBase
 QFutureInterfaceBase (State initialState=NoState)
 QFutureInterfaceBase (const QFutureInterfaceBase &other)
 QFutureInterfaceBase (QFutureInterfaceBase &&other) noexcept
QFutureInterfaceBase & operator= (const QFutureInterfaceBase &other)
virtual ~QFutureInterfaceBase ()
void reportStarted ()
void reportFinished ()
void reportCanceled ()
void reportException (const QException &e)
void reportException (const std::exception_ptr &e)
void reportResultsReady (int beginIndex, int endIndex)
void setRunnable (QRunnable *runnable)
void setThreadPool (QThreadPool *pool)
QThreadPool * threadPool () const
void setFilterMode (bool enableenable)
void setProgressRange (int minimum, int maximum)
int progressMinimum () const
int progressMaximum () const
bool isProgressUpdateNeeded () const
void setProgressValue (int progressValue)
int progressValue () const
void setProgressValueAndText (int progressValue, const QString &progressText)
QString progressText () const
void setExpectedResultCount (int resultCount)
int expectedResultCount ()
int resultCount () const
bool queryState (State state) const
bool isRunning () const
bool isStarted () const
bool isCanceled () const
bool isFinished () const
bool isSuspending () const
bool isSuspended () const
bool isThrottled () const
bool isResultReadyAt (int indexindex) const
bool isValid () const
int loadState () const
void cancel ()
void cancelAndFinish ()
void cancelChain ()
void setAddResultsIfCanceledEnabled (bool enableenable)
bool isAddResultsIfCanceledEnabled () const
void setSuspended (bool suspend)
void toggleSuspended ()
void reportSuspended () const
void setThrottled (bool enableenable)
void waitForFinished ()
bool waitForNextResult ()
void waitForResult (int resultIndex)
void waitForResume ()
void suspendIfRequested ()
QMutex & mutex () const
bool hasException () const
QtPrivate::ExceptionStore & exceptionStore ()
QtPrivate::ResultStoreBase & resultStoreBase ()
const QtPrivate::ResultStoreBase & resultStoreBase () const
bool operator== (const QFutureInterfaceBase &other) const
bool operator!= (const QFutureInterfaceBase &other) const
void swap (QFutureInterfaceBase &other) noexcept
bool isChainCanceled () const

Static Public Member Functions

static QFutureInterface canceledResult ()
Static Public Member Functions inherited from QFutureInterfaceBase
template<typename T>
static QFutureInterfaceBase get (const QFuture< T > &future)

Additional Inherited Members

Public Types inherited from QFutureInterfaceBase
enum  State {
  NoState = 0x00 , Running = 0x01 , Started = 0x02 , Finished = 0x04 ,
  Canceled = 0x08 , Suspending = 0x10 , Suspended = 0x20 , Throttled = 0x40 ,
  Pending = 0x80
}
Protected Types inherited from QFutureInterfaceBase
enum class  ContinuationType : quint8 { Unknown , Then , OnFailed , OnCanceled }
enum class  CancelMode { CancelOnly , CancelAndFinish }
Protected Member Functions inherited from QFutureInterfaceBase
bool refT () const noexcept
bool derefT () const noexcept
void reset ()
void rethrowPossibleException ()
void setContinuation (std::function< void(const QFutureInterfaceBase &)> funcfunc, void *continuationFutureData, ContinuationType typetype)
void setContinuation (const QObject *context, std::function< void()> funcfunc, const QVariant &continuationFuture, ContinuationType typetype)
void cleanContinuation ()
void runContinuation () const
void setLaunchAsync (bool valuevalue)
bool launchAsync () const
bool isRunningOrPending () const
void cancel (CancelMode modemode)
void cancelChain (CancelMode modemode)

Detailed Description

template<typename T>
class QFutureInterface< T >

Definition at line 241 of file qfutureinterface.h.

Constructor & Destructor Documentation

◆ QFutureInterface() [1/5]

template<typename T>
QFutureInterface< T >::QFutureInterface ( State initialState = NoState)
inline

Definition at line 244 of file qfutureinterface.h.

◆ QFutureInterface() [2/5]

template<typename T>
QFutureInterface< T >::QFutureInterface ( const QFutureInterface< T > & other)
inline

Definition at line 249 of file qfutureinterface.h.

◆ QFutureInterface() [3/5]

template<typename T>
QFutureInterface< T >::QFutureInterface ( const QFutureInterfaceBase & dd)
inline

Definition at line 254 of file qfutureinterface.h.

◆ QFutureInterface() [4/5]

template<typename T>
QFutureInterface< T >::QFutureInterface ( QFutureInterfaceBase && dd)
inlinenoexcept

Definition at line 255 of file qfutureinterface.h.

◆ QFutureInterface() [5/5]

template<typename T>
QFutureInterface< T >::QFutureInterface ( QFutureInterface< T > && other)
default

◆ ~QFutureInterface()

template<typename T>
QFutureInterface< T >::~QFutureInterface ( )
inline

Definition at line 265 of file qfutureinterface.h.

Member Function Documentation

◆ canceledResult()

template<typename T>
QFutureInterface QFutureInterface< T >::canceledResult ( )
inlinestatic

Definition at line 271 of file qfutureinterface.h.

◆ future()

template<typename T>
QFuture< T > QFutureInterface< T >::future ( )
inline

Definition at line 326 of file qfuture.h.

◆ operator=()

template<typename T>
QFutureInterface & QFutureInterface< T >::operator= ( const QFutureInterface< T > & other)
inline

Definition at line 256 of file qfutureinterface.h.

◆ reportAndEmplaceResult()

template<typename T>
template<typename... Args, std::enable_if_t< std::is_constructible_v< T, Args... >, bool >>
bool QFutureInterface< T >::reportAndEmplaceResult ( int index,
Args &&... args )
inline

Definition at line 344 of file qfutureinterface.h.

◆ reportAndMoveResult()

template<typename T>
bool QFutureInterface< T >::reportAndMoveResult ( T && result,
int index = -1 )
inline

Definition at line 362 of file qfutureinterface.h.

Referenced by reportResult().

Here is the caller graph for this function:

◆ reportException() [1/2]

template<typename T>
void QFutureInterface< T >::reportException ( const QException & e)
inline

Definition at line 309 of file qfutureinterface.h.

◆ reportException() [2/2]

template<typename T>
void QFutureInterface< T >::reportException ( const std::exception_ptr & e)
inline

Definition at line 301 of file qfutureinterface.h.

◆ reportFinished() [1/2]

template<typename T>
void QFutureInterface< T >::reportFinished ( )
inline

Definition at line 284 of file qfutureinterface.h.

◆ reportFinished() [2/2]

template<typename T>
bool QFutureInterface< T >::reportFinished ( const T * result)
inline

Definition at line 402 of file qfutureinterface.h.

◆ reportResult() [1/3]

template<typename T>
bool QFutureInterface< T >::reportResult ( const T & result,
int index = -1 )
inline

Definition at line 374 of file qfutureinterface.h.

◆ reportResult() [2/3]

template<typename T>
bool QFutureInterface< T >::reportResult ( const T * result,
int index = -1 )
inline

Definition at line 321 of file qfutureinterface.h.

◆ reportResult() [3/3]

template<typename T>
bool QFutureInterface< T >::reportResult ( T && result,
int index = -1 )
inline

Definition at line 368 of file qfutureinterface.h.

References reportAndMoveResult().

Here is the call graph for this function:

◆ reportResults()

template<typename T>
bool QFutureInterface< T >::reportResults ( const QList< T > & results,
int beginIndex = -1,
int count = -1 )
inline

Definition at line 380 of file qfutureinterface.h.

◆ resultPointer()

template<typename T>
const T * QFutureInterface< T >::resultPointer ( int index) const
inline

Definition at line 421 of file qfutureinterface.h.

◆ resultReference()

template<typename T>
const T & QFutureInterface< T >::resultReference ( int index) const
inline

Definition at line 412 of file qfutureinterface.h.

◆ results()

template<typename T>
QList< T > QFutureInterface< T >::results ( )
inline

Definition at line 430 of file qfutureinterface.h.

◆ takeResult()

template<typename T>
T QFutureInterface< T >::takeResult ( )

Definition at line 452 of file qfutureinterface.h.

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