FCancellationToken

Navigation

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Tasks

References

Syntax

class FCancellationToken  
Copy full snippet

class FCancellationToken

Remarks

Support for canceling tasks mid-execution usage: FCancellationToken Token; Launch(UE_SOURCE_LOCATION, [&Token] { ... if (Token.IsCanceled()) return; ... }); Token.Cancel();

• it's user's decision and responsibility to manage cancellation token lifetime, to check cancellation token, return early, to do any required cleanup, or to do nothing at all
• no way to cancel a task to skip its execution completely
• waiting for a canceled task is blocking until its prerequisites are completed and the task is executed and completed, basically same as for not canceled tasks except a canceled one can quit execution early
• canceling a task doesn't affect its subsequents (unless they use the same cancellation token instance)

Constructors

Functions

Operators