FAsyncReadRequestNull Class Reference

#include <AsyncFileHandleNull.h>

Inheritance diagram for FAsyncReadRequestNull:

Public Member Functions
	FAsyncReadRequestNull (FAsyncFileCallBack *InCallback, bool bInSizeRequest)
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

Protected Member Functions
virtual void	WaitCompletionImpl (float TimeLimitSeconds) override
virtual void	CancelImpl () override
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 IAsyncReadRequest
union {
PTRINT   Size
uint8 *   Memory
};
FAsyncFileCallBack	Callback
const bool	bSizeRequest
const bool	bUserSuppliedMemory

Detailed Description

IAsyncReadRequest returned from FAsyncReadFileHandleNull; guaranteed to be a cancelled readrequest with no size or bytes when the Callback is called.

Constructor & Destructor Documentation

FAsyncReadRequestNull()

FAsyncReadRequestNull::FAsyncReadRequestNull ( FAsyncFileCallBack *  InCallback, bool  bInSizeRequest  )

inline

Member Function Documentation

CancelImpl()

virtual void FAsyncReadRequestNull::CancelImpl ( )

inlineoverrideprotectedvirtual

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

Implements IAsyncReadRequest.

ReleaseMemoryOwnershipImpl()

virtual void FAsyncReadRequestNull::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.

WaitCompletionImpl()

virtual void FAsyncReadRequestNull::WaitCompletionImpl ( float  TimeLimitSeconds )

inlineoverrideprotectedvirtual

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/Core/Public/Async/AsyncFileHandleNull.h