FGenericSizeRequest Class Reference

Inheritance diagram for FGenericSizeRequest:

Public Member Functions
	FGenericSizeRequest (IPlatformFile *InLowerLevel, const TCHAR *InFilename, FAsyncFileCallBack *CompleteCallback)
virtual void	PerformRequest () override
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 ()
uint8 *	GetReadResults ()
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
IPlatformFile *	LowerLevel
const TCHAR *	Filename
Protected Attributes inherited from IAsyncReadRequest
union {
PTRINT   Size
uint8 *   Memory
};
FAsyncFileCallBack	Callback
const bool	bSizeRequest
const bool	bUserSuppliedMemory

Constructor & Destructor Documentation

FGenericSizeRequest()

FGenericSizeRequest::FGenericSizeRequest ( IPlatformFile *  InLowerLevel, const TCHAR *  InFilename, FAsyncFileCallBack *  CompleteCallback  )

inline

Member Function Documentation

PerformRequest()

virtual void FGenericSizeRequest::PerformRequest ( )

inlineoverridevirtual

Implements FGenericBaseRequest.

ReleaseMemoryOwnershipImpl()

virtual void FGenericSizeRequest::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:

• Engine/Source/Runtime/Core/Private/GenericPlatform/GenericPlatformFile.cpp