#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 index, Args &&...args)

bool	reportResult (const T *result, int index=-1)

bool	reportAndMoveResult (T &&result, int index=-1)

bool	reportResult (T &&result, int index=-1)

bool	reportResult (const T &result, int index=-1)

bool	reportResults (const QList< T > &results, int beginIndex=-1, int count=-1)

bool	reportFinished (const T *result)

void	reportFinished ()

const T &	resultReference (int index) const

const T *	resultPointer (int index) 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 enable)

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 index) const

bool	isValid () const

int	loadState () const

void	cancel ()

void	cancelAndFinish ()

void	cancelChain ()

void	setSuspended (bool suspend)

void	toggleSuspended ()

void	reportSuspended () const

void	setThrottled (bool enable)

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 &)> func, void *continuationFutureData, ContinuationType type)

void	setContinuation (const QObject *context, std::function< void()> func, const QVariant &continuationFuture, ContinuationType type)

void	cleanContinuation ()

void	runContinuation () const

void	setLaunchAsync (bool value)

bool	launchAsync () const

bool	isRunningOrPending () const

void	cancel (CancelMode mode)

void	cancelChain (CancelMode mode)

Detailed Description

template<typename T>
class QFutureInterface< T >

Definition at line 234 of file qfutureinterface.h.

Constructor & Destructor Documentation

◆ QFutureInterface() [1/5]

template<typename T>

QFutureInterface< T >::QFutureInterface ( State initialState = NoState )

inline

Definition at line 237 of file qfutureinterface.h.

◆ QFutureInterface() [2/5]

template<typename T>

QFutureInterface< T >::QFutureInterface ( const QFutureInterface< T > & other )

inline

Definition at line 242 of file qfutureinterface.h.

◆ QFutureInterface() [3/5]

template<typename T>

QFutureInterface< T >::QFutureInterface ( const QFutureInterfaceBase & dd )

inline

Definition at line 247 of file qfutureinterface.h.

◆ QFutureInterface() [4/5]

template<typename T>

QFutureInterface< T >::QFutureInterface ( QFutureInterfaceBase && dd )

inlinenoexcept

Definition at line 248 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 258 of file qfutureinterface.h.

References ~QFutureInterface().

Referenced by ~QFutureInterface(), canceledResult(), QtPrivate::CanceledHandler< Function, ResultType >::create(), QtPrivate::CompactContinuation< Function, ResultType, ParentResultType >::create(), QtPrivate::CompactContinuation< Function, ResultType, ParentResultType >::create(), QtPrivate::FailureHandler< Function, ResultType >::create(), QtFuture::makeExceptionalFuture(), QtPrivate::makeReadyRangeFutureImpl(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ canceledResult()

template<typename T>

static QFutureInterface QFutureInterface< T >::canceledResult ( )

inlinestatic

Definition at line 264 of file qfutureinterface.h.

References ~QFutureInterface().

Here is the call graph for this function:

◆ future()

template<typename T>

QFuture< T > QFutureInterface< T >::future ( )

inline

Definition at line 325 of file qfuture.h.

◆ operator=()

template<typename T>

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

inline

Definition at line 249 of file qfutureinterface.h.

References ~QFutureInterface().

Here is the call graph for this function:

◆ 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 337 of file qfutureinterface.h.

◆ reportAndMoveResult()

template<typename T>

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

inline

Definition at line 355 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 302 of file qfutureinterface.h.

◆ reportException() [2/2]

template<typename T>

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

inline

Definition at line 294 of file qfutureinterface.h.

◆ reportFinished() [1/2]

template<typename T>

void QFutureInterface< T >::reportFinished ( )

inline

Definition at line 277 of file qfutureinterface.h.

◆ reportFinished() [2/2]

template<typename T>

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

inline

Definition at line 395 of file qfutureinterface.h.

◆ reportResult() [1/3]

template<typename T>

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

inline

Definition at line 367 of file qfutureinterface.h.

◆ reportResult() [2/3]

template<typename T>

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

inline

Definition at line 314 of file qfutureinterface.h.

◆ reportResult() [3/3]

template<typename T>

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

inline

Definition at line 361 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 373 of file qfutureinterface.h.

◆ resultPointer()

template<typename T>

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

inline

Definition at line 414 of file qfutureinterface.h.

◆ resultReference()

template<typename T>

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

inline

Definition at line 405 of file qfutureinterface.h.

◆ results()

template<typename T>

QList< T > QFutureInterface< T >::results ( )

inline

Definition at line 423 of file qfutureinterface.h.

◆ takeResult()

template<typename T>

T QFutureInterface< T >::takeResult ( )

Definition at line 445 of file qfutureinterface.h.

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

qtbase/src/corelib/thread/qfuture_impl.h (b0e82f598193f7d2c331a7ff3da7e2d3114db714)
qtbase/src/corelib/thread/qfutureinterface.h (cdc71532ec2b5d29995f0f34249ebe2174b28c9c)
qtbase/src/corelib/thread/qfuture.h (ff6bf61b17ee4fc8ca11e016242d7c3399a02045)

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QFutureInterface() [1/5]

◆ QFutureInterface() [2/5]

◆ QFutureInterface() [3/5]

◆ QFutureInterface() [4/5]

◆ QFutureInterface() [5/5]

◆ ~QFutureInterface()

Member Function Documentation

◆ canceledResult()

◆ future()

◆ operator=()

◆ reportAndEmplaceResult()

◆ reportAndMoveResult()

◆ reportException() [1/2]

◆ reportException() [2/2]

◆ reportFinished() [1/2]

◆ reportFinished() [2/2]

◆ reportResult() [1/3]

◆ reportResult() [2/3]

◆ reportResult() [3/3]

◆ reportResults()

◆ resultPointer()

◆ resultReference()

◆ results()

◆ takeResult()