TFutureBase

[TFuture](API\Runtime\Core\Async\TFuture) Abstract base template for futures and shared futures.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Async/Future.h

Include

#include "Async/Future.h"

Syntax

template<typename InternalResultType>
class TFutureBase

Remarks

TFuture Abstract base template for futures and shared futures.

Constructors

Name Description

Protected function

TFutureBase()

Default constructor.

Protected function

TFutureBase

(
    const StateType& InState
)

Creates and initializes a new instance.

Protected function

TFutureBase

(
    TFutureBase&&
)

Protected move construction

Protected function

TFutureBase

(
    const TFutureBase&
)

Protected copy construction

Destructors

Name Description

Protected function

~TFutureBase()

Protected destructor.

Functions

Name Description

Protected function Const

const StateT...

 

GetState()

Gets the shared state object.

Public function Const

bool

 

IsReady()

Checks whether this future object has its value set.

Public function Const

bool

 

IsValid()

Checks whether this future object has a valid state.

Protected function

auto

 

Next

(
    Func Continuation
)

Next implementation.

Protected function

void

 

Reset()

Reset the future.

Protected function

auto

 

Then

(
    Func Continuation
)

Then implementation.

Public function Const

void

 

Wait()

Blocks the calling thread until the future result is available.

Public function Const

bool

 

WaitFor

(
    const FTimespan& Duration
)

Blocks the calling thread until the future result is available or the specified duration is exceeded.

Public function Const

bool

 

WaitUntil

(
    const FDateTime& Time
)

Blocks the calling thread until the future result is available or the specified time is hit.

Operators

Name Description

Protected function

TFutureBase ...

 

operator=

(
    TFutureBase&&
)

Protected move assignment

Protected function

TFutureBase ...

 

operator=

(
    const TFutureBase&
)

Protected copy assignment

Typedefs

Name

Description

StateType

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss