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

Public Member Functions

 FPakAsyncReadFileHandle (const FPakEntry *InFileEntry, const TRefCountPtr< FPakFile > &InPakFile, const TCHAR *Filename)
 
 ~FPakAsyncReadFileHandle ()
 
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
 
void StartBlock (int32 BlockIndex, EAsyncIOPriorityAndFlags PriorityAndFlags)
 
void RawReadCallback (bool bWasCancelled, IAsyncReadRequest *InRequest)
 
void DoProcessing (FCachedAsyncBlock *BlockPtr)
 
void ClearBlock (FCachedAsyncBlock &Block, bool bForDestructorShouldAlreadyBeClear=false)
 
void RemoveRequest (FPakProcessedReadRequest *Req, int64 Offset, int64 BytesToRead, const bool &bAlreadyCancelled)
 
void HandleCanceledRequest (TSet< FCachedAsyncBlock * > &MyCanceledBlocks, FPakProcessedReadRequest *Req, int64 Offset, int64 BytesToRead, bool &bHasCancelledRef)
 
void GatherResults (uint8 *Memory, int64 Offset, int64 BytesToRead)
 
- Public Member Functions inherited from IAsyncReadFileHandle
 IAsyncReadFileHandle ()
 
virtual ~IAsyncReadFileHandle ()
 
virtual bool UsesCache ()
 
virtual void ShrinkHandleBuffers ()
 
 IAsyncReadFileHandle (const IAsyncReadFileHandle &)=delete
 
IAsyncReadFileHandle & operator= (const IAsyncReadFileHandle &)=delete
 

Constructor & Destructor Documentation

◆ FPakAsyncReadFileHandle()

FPakAsyncReadFileHandle::FPakAsyncReadFileHandle ( const FPakEntry *  InFileEntry,
const TRefCountPtr< FPakFile > &  InPakFile,
const TCHAR *  Filename 
)
inline

◆ ~FPakAsyncReadFileHandle()

FPakAsyncReadFileHandle::~FPakAsyncReadFileHandle ( )
inline

Member Function Documentation

◆ ClearBlock()

void FPakAsyncReadFileHandle::ClearBlock ( FCachedAsyncBlock &  Block,
bool  bForDestructorShouldAlreadyBeClear = false 
)
inline

◆ DoProcessing()

void FPakAsyncReadFileHandle::DoProcessing ( FCachedAsyncBlock *  BlockPtr)
inline

◆ GatherResults()

void FPakAsyncReadFileHandle::GatherResults ( uint8 *  Memory,
int64  Offset,
int64  BytesToRead 
)
inline

◆ HandleCanceledRequest()

void FPakAsyncReadFileHandle::HandleCanceledRequest ( TSet< FCachedAsyncBlock * > &  MyCanceledBlocks,
FPakProcessedReadRequest *  Req,
int64  Offset,
int64  BytesToRead,
bool &  bHasCancelledRef 
)
inline

◆ RawReadCallback()

void FPakAsyncReadFileHandle::RawReadCallback ( bool  bWasCancelled,
IAsyncReadRequest *  InRequest 
)
inline

◆ ReadRequest()

virtual IAsyncReadRequest * FPakAsyncReadFileHandle::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 FPakAsyncReadFileHandle::RemoveRequest ( FPakProcessedReadRequest *  Req,
int64  Offset,
int64  BytesToRead,
const bool &  bAlreadyCancelled 
)
inline

◆ SizeRequest()

virtual IAsyncReadRequest * FPakAsyncReadFileHandle::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.

◆ StartBlock()

void FPakAsyncReadFileHandle::StartBlock ( int32  BlockIndex,
EAsyncIOPriorityAndFlags  PriorityAndFlags 
)
inline
The documentation for this class was generated from the following file: