UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FGenericAsyncReadFileHandle Class Referencefinal
+ Inheritance diagram for FGenericAsyncReadFileHandle:

Public Member Functions

 FGenericAsyncReadFileHandle (IPlatformFile *InLowerLevel, const TCHAR *InFilename, bool bInAllowWrite)
 
 ~FGenericAsyncReadFileHandle ()
 
void RemoveRequest (FGenericReadRequest *Req)
 
uint8 * GetPrecachedBlock (uint8 *UserSuppliedMemory, int64 InOffset, int64 InBytesToRead)
 
virtual IAsyncReadRequest * SizeRequest (FAsyncFileCallBack *CompleteCallback=nullptr) override
 
virtual IAsyncReadRequest * ReadRequest (int64 Offset, int64 BytesToRead, EAsyncIOPriorityAndFlags PriorityAndFlags=AIOP_Normal, FAsyncFileCallBack *CompleteCallback=nullptr, uint8 *UserSuppliedMemory=nullptr) override
 
virtual void ShrinkHandleBuffers () override
 
IFileHandle * GetHandle ()
 
void FreeHandle (IFileHandle *Handle)
 
- Public Member Functions inherited from IAsyncReadFileHandle
 IAsyncReadFileHandle ()
 
virtual ~IAsyncReadFileHandle ()
 
virtual bool UsesCache ()
 
 IAsyncReadFileHandle (const IAsyncReadFileHandle &)=delete
 
IAsyncReadFileHandle & operator= (const IAsyncReadFileHandle &)=delete
 

Constructor & Destructor Documentation

◆ FGenericAsyncReadFileHandle()

FGenericAsyncReadFileHandle::FGenericAsyncReadFileHandle ( IPlatformFile *  InLowerLevel,
const TCHAR *  InFilename,
bool  bInAllowWrite 
)
inline

◆ ~FGenericAsyncReadFileHandle()

FGenericAsyncReadFileHandle::~FGenericAsyncReadFileHandle ( )
inline

Member Function Documentation

◆ FreeHandle()

void FGenericAsyncReadFileHandle::FreeHandle ( IFileHandle *  Handle)
inline

◆ GetHandle()

IFileHandle * FGenericAsyncReadFileHandle::GetHandle ( )
inline

◆ GetPrecachedBlock()

uint8 * FGenericAsyncReadFileHandle::GetPrecachedBlock ( uint8 *  UserSuppliedMemory,
int64  InOffset,
int64  InBytesToRead 
)
inline

◆ ReadRequest()

virtual IAsyncReadRequest * FGenericAsyncReadFileHandle::ReadRequest ( int64  Offset,
int64  BytesToRead,
EAsyncIOPriorityAndFlags  PriorityAndFlags = AIOP_Normal,
FAsyncFileCallBack *  CompleteCallback = nullptr,
uint8 *  UserSuppliedMemory = nullptr 
)
inlineoverridevirtual

Submit an async request and/or wait for an async request

Parameters
OffsetOffset into the file to start reading.
BytesToReadnumber of bytes to read. If this request is AIOP_Preache, the size can be anything, even MAX_int64, otherwise the size and offset must be fully contained in the file.
PriorityAndFlagsPriority and flags of the request. If this includes AIOP_FLAG_PRECACHE, then memory will never be returned. The request should always be canceled and waited for, even for a precache request.
CompleteCallbackCalled from an arbitrary thread when the request is complete. Can be nullptr, if non-null, must remain valid until it is called. It will always be called.
Returns
A request for the read. This is owned by the caller and must be deleted by the caller.

Implements IAsyncReadFileHandle.

◆ RemoveRequest()

void FGenericAsyncReadFileHandle::RemoveRequest ( FGenericReadRequest *  Req)
inline

◆ ShrinkHandleBuffers()

virtual void FGenericAsyncReadFileHandle::ShrinkHandleBuffers ( )
inlineoverridevirtual

Minimizes buffers held internally by this handle.

Reimplemented from IAsyncReadFileHandle.

◆ SizeRequest()

virtual IAsyncReadRequest * FGenericAsyncReadFileHandle::SizeRequest ( FAsyncFileCallBack *  CompleteCallback = nullptr)
inlineoverridevirtual

Request the size of the file. This is also essentially the existence check.

Parameters
CompleteCallbackCalled from an arbitrary thread when the request is complete. Can be nullptr, if non-null, must remain valid until it is called. It will always be called.
Returns
A request for the size. This is owned by the caller and must be deleted by the caller.

Implements IAsyncReadFileHandle.

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