IAsyncReadRequest | Unreal Engine 5.5 Documentation

Inheritance Hierarchy


Module	Core
Header	/Engine/Source/Runtime/Core/Public/Async/AsyncFileHandle.h
Include	#include "Async/AsyncFileHandle.h"

class IAsyncReadRequest : public IAsyncReadRequestFixLayout

	Type	Name	Description
	union IAsyncReadRequest
	bool	bCanceled
	bool	bCompleteAndCallbackCalled
	bool	bCompleteSync
	bool	bDataIsReady
	const bool	bSizeRequest
	const bool	bUserSuppliedMemory
	FAsyncFileCallBack	Callback
	uint8 *	Memory
	PTRINT	Size

	Type	Name	Description
		IAsyncReadRequest ( FAsyncFileCallBack* InCallback, bool bInSizeRequest, uint8* UserSuppliedMemory )

	Type	Name	Description
		~IAsyncReadRequest ()	Not legal to destroy the request until it is complete.

Type	Name	Description
void	Cancel ()	Cancel the request. This is a non-blocking async call and so does not ensure completion!
void	CancelImpl ()	Cancel the request. This is a non-blocking async call and so does not ensure completion!
void	EnsureCompletion ()	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().
uint8 *	GetReadResults ()	Return the bytes of a completed read request. Not legal to call unless the request is complete.
int64	GetSizeResults ()	Return the size of a completed size request. Not legal to call unless the request is complete.
bool	PollCompletion ()	Nonblocking poll of the state of completion.
void	ReleaseMemoryOwnershipImpl ()	Transfer ownership of Memory from the async request to the outside caller (called in response to GetReadResults).
void	SetAllComplete ()
void	SetComplete ()
void	SetDataComplete ()
bool	WaitCompletion ( float TimeLimitSeconds )	Waits for the request to complete, but not longer than the given time limit
void	WaitCompletionImpl ( float TimeLimitSeconds )	Waits for the request to complete, but not longer than the given time limit