FGenericBaseRequest Class Reference

Inheritance diagram for FGenericBaseRequest:

Public Member Functions
	FGenericBaseRequest (IPlatformFile *InLowerLevel, const TCHAR *InFilename, FAsyncFileCallBack *CompleteCallback, bool bInSizeRequest, uint8 *UserSuppliedMemory=nullptr)
void	Start ()
virtual	~FGenericBaseRequest ()
virtual void	PerformRequest ()=0
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 Attributes
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

Additional Inherited Members
Protected Member Functions inherited from IAsyncReadRequest
	TSAN_ATOMIC (bool) bDataIsReady
	TSAN_ATOMIC (bool) bCompleteAndCallbackCalled
	TSAN_ATOMIC (bool) bCompleteSync
	TSAN_ATOMIC (bool) bCanceled
virtual void	ReleaseMemoryOwnershipImpl ()=0
void	SetDataComplete ()
void	SetAllComplete ()
void	SetComplete ()

Constructor & Destructor Documentation

FGenericBaseRequest()

FGenericBaseRequest::FGenericBaseRequest ( IPlatformFile *  InLowerLevel, const TCHAR *  InFilename, FAsyncFileCallBack *  CompleteCallback, bool  bInSizeRequest, uint8 *  UserSuppliedMemory = nullptr  )

inline

~FGenericBaseRequest()

virtual FGenericBaseRequest::~FGenericBaseRequest ( )

inlinevirtual

Member Function Documentation

CancelImpl()

virtual void FGenericBaseRequest::CancelImpl ( )

inlineoverridevirtual

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

Implements IAsyncReadRequest.

EnsureCompletion()

virtual void FGenericBaseRequest::EnsureCompletion ( )

inlineoverridevirtual

Waits for the request to complete, with an additional guarantee that the second consecutive call won't ever block, which is not a case for WaitCompletion().

Reimplemented from IAsyncReadRequest.

PerformRequest()

virtual void FGenericBaseRequest::PerformRequest ( )

pure virtual

Implemented in FGenericSizeRequest, and FGenericReadRequest.

Start()

void FGenericBaseRequest::Start ( )

inline

WaitCompletionImpl()

virtual void FGenericBaseRequest::WaitCompletionImpl ( float  TimeLimitSeconds )

inlineoverridevirtual

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.

Member Data Documentation

Filename

const TCHAR* FGenericBaseRequest::Filename

protected

LowerLevel

IPlatformFile* FGenericBaseRequest::LowerLevel

protected

Task

FAsyncTask<FGenericReadRequestWorker>* FGenericBaseRequest::Task

protected

---

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

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