Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
A single task for an online service to be queued with the async task manager Originates on the game thread
| Name | FOnlineAsyncTask |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineAsyncTaskManager.h |
| Include Path | #include "OnlineAsyncTaskManager.h" |
Syntax
class FOnlineAsyncTask : public FOnlineAsyncItem
Inheritance Hierarchy
- FOnlineAsyncItem → FOnlineAsyncTask
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOnlineAsyncTask() |
Hidden on purpose | OnlineAsyncTaskManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FOnlineAsyncTask() |
OnlineAsyncTaskManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CancelWhenTimeout() |
If cancel is supported, cancel when timeout if timeout is set for this task Not putting this in Tick directly because existing subclasses could be overriding Tick without calling super::Tick | OnlineAsyncTaskManager.h | |
virtual void Initialize() |
Initialize the task - called on game thread when queued | OnlineAsyncTaskManager.h | |
bool IsDone() |
Check the state of the async task | OnlineAsyncTaskManager.h | |
virtual void Tick() |
Give the async task time to do its work Can only be called on the async task manager thread | OnlineAsyncTaskManager.h | |
bool WasSuccessful() |
Check the success of the async task | OnlineAsyncTaskManager.h |