FMicrosoftAsyncReadFileHandle Class Reference

#include <MicrosoftAsyncIO.h>

Inheritance diagram for FMicrosoftAsyncReadFileHandle:

Public Member Functions
	FMicrosoftAsyncReadFileHandle (HANDLE InFileHandle, const TCHAR *InFileNameForErrorMessagesAndPanicRetry)
	~FMicrosoftAsyncReadFileHandle ()
void	RemoveRequest (FMicrosoftReadRequest *Req)
uint8 *	GetPrecachedBlock (uint8 *UserSuppliedMemory, int64 InOffset, int64 InBytesToRead)
virtual IAsyncReadRequest *	SizeRequest (FAsyncFileCallBack *CompleteCallback=nullptr) override
virtual IAsyncReadRequest *	ReadRequest (int64 Offset, int64 BytesToRead, EAsyncIOPriorityAndFlags PriorityAndFlags=AIOP_Normal, FAsyncFileCallBack *CompleteCallback=nullptr, uint8 *UserSuppliedMemory=nullptr) override
Public Member Functions inherited from IAsyncReadFileHandle
	IAsyncReadFileHandle ()
virtual	~IAsyncReadFileHandle ()
virtual bool	UsesCache ()
virtual void	ShrinkHandleBuffers ()
	IAsyncReadFileHandle (const IAsyncReadFileHandle &)=delete
IAsyncReadFileHandle &	operator= (const IAsyncReadFileHandle &)=delete

Public Attributes
HANDLE	FileHandle
int64	FileSize
FString	FileNameForErrorMessagesAndPanicRetry

Constructor & Destructor Documentation

FMicrosoftAsyncReadFileHandle()

FMicrosoftAsyncReadFileHandle::FMicrosoftAsyncReadFileHandle ( HANDLE  InFileHandle, const TCHAR *  InFileNameForErrorMessagesAndPanicRetry  )

inline

~FMicrosoftAsyncReadFileHandle()

FMicrosoftAsyncReadFileHandle::~FMicrosoftAsyncReadFileHandle ( )

inline

Member Function Documentation

GetPrecachedBlock()

uint8 * FMicrosoftAsyncReadFileHandle::GetPrecachedBlock ( uint8 *  UserSuppliedMemory, int64  InOffset, int64  InBytesToRead  )

inline

ReadRequest()

virtual IAsyncReadRequest * FMicrosoftAsyncReadFileHandle::ReadRequest ( int64  Offset, int64  BytesToRead, EAsyncIOPriorityAndFlags  PriorityAndFlags = AIOP_Normal, FAsyncFileCallBack *  CompleteCallback = nullptr, uint8 *  UserSuppliedMemory = nullptr  )

inlineoverridevirtual

Submit an async request and/or wait for an async request

Parameters

Offset	Offset into the file to start reading.
BytesToRead	number of bytes to read. If this request is AIOP_Preache, the size can be anything, even MAX_int64, otherwise the size and offset must be fully contained in the file.
PriorityAndFlags	Priority and flags of the request. If this includes AIOP_FLAG_PRECACHE, then memory will never be returned. The request should always be canceled and waited for, even for a precache request.
CompleteCallback	Called from an arbitrary thread when the request is complete. Can be nullptr, if non-null, must remain valid until it is called. It will always be called.

Returns

A request for the read. This is owned by the caller and must be deleted by the caller.

Implements IAsyncReadFileHandle.

RemoveRequest()

void FMicrosoftAsyncReadFileHandle::RemoveRequest ( FMicrosoftReadRequest *  Req )

inline

SizeRequest()

virtual IAsyncReadRequest * FMicrosoftAsyncReadFileHandle::SizeRequest ( FAsyncFileCallBack *  CompleteCallback = nullptr )

inlineoverridevirtual

Request the size of the file. This is also essentially the existence check.

Parameters

CompleteCallback

Called from an arbitrary thread when the request is complete. Can be nullptr, if non-null, must remain valid until it is called. It will always be called.

Returns

A request for the size. This is owned by the caller and must be deleted by the caller.

Implements IAsyncReadFileHandle.

Member Data Documentation

FileHandle

HANDLE FMicrosoftAsyncReadFileHandle::FileHandle

FileNameForErrorMessagesAndPanicRetry

FString FMicrosoftAsyncReadFileHandle::FileNameForErrorMessagesAndPanicRetry

FileSize

int64 FMicrosoftAsyncReadFileHandle::FileSize

---

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

• Engine/Source/Runtime/Core/Private/Microsoft/MicrosoftAsyncIO.h