UE::BulkData::Private::FChunkReadFileRequest Class Reference

Inheritance diagram for UE::BulkData::Private::FChunkReadFileRequest:

Public Member Functions
	FChunkReadFileRequest (FAsyncFileCallBack *Callback, FIoBuffer &&InBuffer)
virtual	~FChunkReadFileRequest ()
virtual void	WaitCompletionImpl (float TimeLimitSeconds) override
virtual void	CancelImpl () override
virtual void	ReleaseMemoryOwnershipImpl () override
virtual void	HandleChunkResult (TIoStatusOr< FIoBuffer > &&Result) override
Public Member Functions inherited from UE::BulkData::Private::FChunkRequest
virtual	~FChunkRequest ()
void	Issue (FIoChunkId ChunkId, FIoReadOptions Options, int32 Priority)
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)
virtual void	EnsureCompletion ()
void	Cancel ()
int64	GetSizeResults ()
uint8 *	GetReadResults ()
Public Member Functions inherited from IAsyncReadRequestFixLayout
virtual	~IAsyncReadRequestFixLayout ()=default

Additional Inherited Members
Protected Member Functions inherited from UE::BulkData::Private::FChunkRequest
	FChunkRequest (FIoBuffer &&InBuffer)
EChunkRequestStatus	GetStatus () const
bool	WaitForChunkRequest (float TimeLimitSeconds=0.0f)
void	CancelChunkRequest ()
int64	GetSizeResult () const
void	UpdatePriority (const uint32 Pri)
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 ()
Protected Attributes inherited from UE::BulkData::Private::FChunkRequest
FIoBuffer	Buffer
Protected Attributes inherited from IAsyncReadRequest
union {
PTRINT   Size
uint8 *   Memory
};
FAsyncFileCallBack	Callback
const bool	bSizeRequest
const bool	bUserSuppliedMemory

Constructor & Destructor Documentation

FChunkReadFileRequest()

UE::BulkData::Private::FChunkReadFileRequest::FChunkReadFileRequest	(	FAsyncFileCallBack *	Callback,
		FIoBuffer &&	InBuffer
	)

~FChunkReadFileRequest()

UE::BulkData::Private::FChunkReadFileRequest::~FChunkReadFileRequest ( )

virtual

Member Function Documentation

CancelImpl()

void UE::BulkData::Private::FChunkReadFileRequest::CancelImpl ( )

overridevirtual

Cancel the request. This is a non-blocking async call and so does not ensure completion!

Implements IAsyncReadRequest.

HandleChunkResult()

void UE::BulkData::Private::FChunkReadFileRequest::HandleChunkResult ( TIoStatusOr< FIoBuffer > &&  Result )

overridevirtual

Implements UE::BulkData::Private::FChunkRequest.

ReleaseMemoryOwnershipImpl()

void UE::BulkData::Private::FChunkReadFileRequest::ReleaseMemoryOwnershipImpl ( )

overridevirtual

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.

WaitCompletionImpl()

void UE::BulkData::Private::FChunkReadFileRequest::WaitCompletionImpl ( float  TimeLimitSeconds )

overridevirtual

Waits for the request to complete, but not longer than the given time limit

Parameters

TimeLimitSeconds

Zero to wait forever, otherwise the maximum amount of time to wait.

Returns

true if the request is complete

Implements IAsyncReadRequest.

---

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

• Engine/Source/Runtime/CoreUObject/Private/Serialization/BulkDataStreaming.cpp