Navigation
API > API/Runtime > API/Runtime/Core
| Name | IAsyncReadRequest |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Async/AsyncFileHandle.h |
| Include Path | #include "Async/AsyncFileHandle.h" |
Syntax
class IAsyncReadRequest : public IAsyncReadRequestFixLayout
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IAsyncReadRequest
(
FAsyncFileCallBack* InCallback, |
Async/AsyncFileHandle.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAsyncReadRequest() |
Not legal to destroy the request until it is complete. | Async/AsyncFileHandle.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Memory | uint8 * | Async/AsyncFileHandle.h | ||
| Size | PTRINT | Async/AsyncFileHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Cancel() |
Cancel the request. This is a non-blocking async call and so does not ensure completion! | Async/AsyncFileHandle.h | |
virtual void EnsureCompletion() |
Waits for the request to complete, with an additional guarantee that the second consecutive call won't ever block, which is not a case for WaitCompletion(). | Async/AsyncFileHandle.h | |
uint8 * GetReadResults() |
Return the bytes of a completed read request. Not legal to call unless the request is complete. | Async/AsyncFileHandle.h | |
int64 GetSizeResults() |
Return the size of a completed size request. Not legal to call unless the request is complete. | Async/AsyncFileHandle.h | |
bool PollCompletion() |
Nonblocking poll of the state of completion. | Async/AsyncFileHandle.h | |
bool WaitCompletion
(
float TimeLimitSeconds |
Waits for the request to complete, but not longer than the given time limit | Async/AsyncFileHandle.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelImpl() |
Cancel the request. This is a non-blocking async call and so does not ensure completion! | Async/AsyncFileHandle.h | |
void ReleaseMemoryOwnershipImpl () |
Transfer ownership of Memory from the async request to the outside caller (called in response to GetReadResults). | Async/AsyncFileHandle.h | |
void SetAllComplete() |
Async/AsyncFileHandle.h | ||
void SetComplete() |
Async/AsyncFileHandle.h | ||
void SetDataComplete() |
Async/AsyncFileHandle.h | ||
void WaitCompletionImpl
(
float TimeLimitSeconds |
Waits for the request to complete, but not longer than the given time limit | Async/AsyncFileHandle.h |