FAppleAsyncTask Class Reference

#include <AppleAsyncTask.h>

Inheritance diagram for FAppleAsyncTask:

Instance Methods
(void)	- FinishedTask

Class Methods
(void)	+ CreateTaskWithBlock:
(void)	+ ProcessAsyncTasks

Properties
id	UserData
bool(^	GameThreadCallback )(void)

Method Documentation

CreateTaskWithBlock:

+ (void) CreateTaskWithBlock:

(bool(^)(void))

Block

Create an async task object, set the block, and mark it as ready to be processed on main thread For advanced uses (ie, setting UserData or delaying when it's ready for game thread, use the usual [[alloc] init] pattern

Note, this doesn't return an AsyncObject so no one is tempted to use it - once it's ready for game thread, it's dangerous to touch it This is callable on any thread, not just main thread

FinishedTask

- (void) FinishedTask

Mark that the task is complete on the iOS thread, and now the GameThread can be fired (the Task is unsafe to use after this call)

ProcessAsyncTasks

+ (void) ProcessAsyncTasks

Tick all currently running tasks

Property Documentation

GameThreadCallback

- (bool(^ GameThreadCallback) (void))

readwriteatomiccopy

Code to run on the game thread when the async task completes

Returns

true when the task is complete, and it will be pulled from the list of tasks and destroyed

UserData

- (id) UserData

readwriteatomicretain

Extra data for this async task

---

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

• Engine/Source/Runtime/Core/Private/Apple/AppleAsyncTask.cpp
• Engine/Source/Runtime/Core/Public/Apple/AppleAsyncTask.h