TFutureBase | Unreal Engine 5.7 Documentation

TFuture Abstract base template for futures and shared futures.


Name	TFutureBase
Type	class
Header File	/Engine/Source/Runtime/Core/Public/Async/Future.h
Include Path	#include "Async/Future.h"

Syntax

template<typename ResultType>  
class TFutureBase

Name	Remarks	Include Path
TFutureBase ()	Default constructor.	Async/Future.h
TFutureBase ( TSharedPtr< StateType >&& InState )	Creates and initializes a new instance.	Async/Future.h
TFutureBase ( const TSharedPtr< StateType >& InState )		Async/Future.h

Name	Type	Include Path
ConstResultType	typename StateType::ConstResultType	Async/Future.h
MutableResultType	typename StateType::MutableResultType	Async/Future.h
RvalueResultType	typename StateType::RvalueResultType	Async/Future.h
StateType	TFutureState< ResultType >	Async/Future.h

Name	Type	Remarks	Include Path	Unreal Specifiers
State	TSharedPtr< StateType >	Holds the future's state.	Async/Future.h

Name	Remarks	Include Path
ConstResultType Get ()	Gets the future's result.Not equivalent to std::future::get(). The future remains valid.	Async/Future.h
ConstResultType Get ()		Async/Future.h
bool IsReady ()	Checks whether this future object has its value set.	Async/Future.h
bool IsValid ()	Checks whether this future object has a valid state.	Async/Future.h
void Wait ()	Blocks the calling thread until the future result is available.	Async/Future.h
bool WaitFor ( const FTimespan& Duration ) const	Blocks the calling thread until the future result is available or the specified duration is exceeded.	Async/Future.h
bool WaitUntil ( const FDateTime& Time ) const	Blocks the calling thread until the future result is available or the specified time is hit.	Async/Future.h

Name	Remarks	Include Path
const TSharedPtr< StateType > & GetState()	Gets the shared state object.	Async/Future.h
auto Next ( Func Continuation )	Next implementation.	Async/Future.h
void Reset ()	Reset the future.	Async/Future.h
auto Then ( Func Continuation )	Then implementation.	Async/Future.h