UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FGenericReadRequest Class Reference
+ Inheritance diagram for FGenericReadRequest:

Public Member Functions

 FGenericReadRequest (FGenericAsyncReadFileHandle *InOwner, IPlatformFile *InLowerLevel, const TCHAR *InFilename, FAsyncFileCallBack *CompleteCallback, uint8 *UserSuppliedMemory, int64 InOffset, int64 InBytesToRead, EAsyncIOPriorityAndFlags InPriorityAndFlags)
 
 ~FGenericReadRequest ()
 
bool CheckForPrecache ()
 
virtual void PerformRequest () override
 
uint8GetContainedSubblock (uint8 *UserSuppliedMemory, int64 InOffset, int64 InBytesToRead)
 
- Public Member Functions inherited from FGenericBaseRequest
 FGenericBaseRequest (IPlatformFile *InLowerLevel, const TCHAR *InFilename, FAsyncFileCallBack *CompleteCallback, bool bInSizeRequest, uint8 *UserSuppliedMemory=nullptr)
 
void Start ()
 
virtual ~FGenericBaseRequest ()
 
virtual void WaitCompletionImpl (float TimeLimitSeconds) override TSAN_SAFE
 
virtual void EnsureCompletion () override
 
virtual void CancelImpl () override
 
- Public Member Functions inherited from IAsyncReadRequest
 IAsyncReadRequest (FAsyncFileCallBack *InCallback, bool bInSizeRequest, uint8 *UserSuppliedMemory)
 
virtual ~IAsyncReadRequest ()
 
UE_FORCEINLINE_HINT bool PollCompletion ()
 
bool WaitCompletion (float TimeLimitSeconds=0.0f)
 
void Cancel ()
 
int64 GetSizeResults ()
 
uint8GetReadResults ()
 
- Public Member Functions inherited from IAsyncReadRequestFixLayout
virtual ~IAsyncReadRequestFixLayout ()=default
 

Protected Member Functions

virtual void ReleaseMemoryOwnershipImpl () override
 
- Protected Member Functions inherited from IAsyncReadRequest
 TSAN_ATOMIC (bool) bDataIsReady
 
 TSAN_ATOMIC (bool) bCompleteAndCallbackCalled
 
 TSAN_ATOMIC (bool) bCompleteSync
 
 TSAN_ATOMIC (bool) bCanceled
 
void SetDataComplete ()
 
void SetAllComplete ()
 
void SetComplete ()
 

Additional Inherited Members

- Protected Attributes inherited from FGenericBaseRequest
FAsyncTask< FGenericReadRequestWorker > * Task
 
IPlatformFileLowerLevel
 
const TCHARFilename
 
- Protected Attributes inherited from IAsyncReadRequest
union { 
 
   PTRINT   Size 
 
   uint8 *   Memory 
 
};  
 
FAsyncFileCallBack Callback
 
const bool bSizeRequest
 
const bool bUserSuppliedMemory
 

Constructor & Destructor Documentation

◆ FGenericReadRequest()

FGenericReadRequest::FGenericReadRequest ( FGenericAsyncReadFileHandle InOwner,
IPlatformFile InLowerLevel,
const TCHAR InFilename,
FAsyncFileCallBack CompleteCallback,
uint8 UserSuppliedMemory,
int64  InOffset,
int64  InBytesToRead,
EAsyncIOPriorityAndFlags  InPriorityAndFlags 
)
inline

◆ ~FGenericReadRequest()

FGenericReadRequest::~FGenericReadRequest ( )

Member Function Documentation

◆ CheckForPrecache()

bool FGenericReadRequest::CheckForPrecache ( )

◆ GetContainedSubblock()

uint8 * FGenericReadRequest::GetContainedSubblock ( uint8 UserSuppliedMemory,
int64  InOffset,
int64  InBytesToRead 
)
inline

◆ PerformRequest()

void FGenericReadRequest::PerformRequest ( )
overridevirtual

Implements FGenericBaseRequest.

◆ ReleaseMemoryOwnershipImpl()

virtual void FGenericReadRequest::ReleaseMemoryOwnershipImpl ( )
inlineoverrideprotectedvirtual

Transfer ownership of Memory from the async request to the outside caller (called in response to GetReadResults). It's only relevant to Read requests, in which case the most common use is to update (decrease) the STAT_AsyncFileMemory stat which is typically incremented when async requests allocate Memory. It doesn't play any role in Size requests, so it may be left empty for them.

Implements IAsyncReadRequest.


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