UE::IPlatformIoDispatcher Class Reference

#include <PlatformIoDispatcher.h>

Inheritance diagram for UE::IPlatformIoDispatcher:

Public Member Functions
virtual	~IPlatformIoDispatcher ()=default
virtual FIoStatus	Initialize ()=0
virtual TIoStatusOr< FIoFileHandle >	OpenFile (const TCHAR *Filename, const FIoFileProperties &FileProperties, FIoFileStat *OutStat=nullptr)=0
virtual FIoStatus	CloseFile (FIoFileHandle FileHandle)=0
virtual FIoFileReadRequest	ScatterGather (FIoScatterGatherRequestParams &&Params, FIoFileReadRequestCompleted &&OnCompleted)=0
virtual FIoFileReadRequest	ReadDirect (FIoDirectReadRequestParams &&Params, FIoFileReadRequestCompleted &&OnCompleted)=0
virtual bool	Tick ()=0
virtual void	UpdatePriority (FIoFileReadRequest Request, int32 NewPriority)=0
virtual void	CancelRequest (FIoFileReadRequest Request)=0
virtual void	CancelAllRequests (FIoFileHandle FileHandle)=0
virtual void	DeleteRequest (FIoFileReadRequest Request)=0

Detailed Description

Interface for platform specific I/O dispatcher.

Constructor & Destructor Documentation

~IPlatformIoDispatcher()

virtual UE::IPlatformIoDispatcher::~IPlatformIoDispatcher ( )

virtualdefault

Member Function Documentation

CancelAllRequests()

virtual void UE::IPlatformIoDispatcher::CancelAllRequests ( FIoFileHandle  FileHandle )

pure virtual

Cancel all inflight I/O request for the specified file.

Implemented in UE::FPlatformIoDispatcherBase.

CancelRequest()

virtual void UE::IPlatformIoDispatcher::CancelRequest ( FIoFileReadRequest  Request )

pure virtual

Cancel inflight I/O request.

Implemented in UE::FPlatformIoDispatcherBase.

CloseFile()

virtual FIoStatus UE::IPlatformIoDispatcher::CloseFile ( FIoFileHandle  FileHandle )

pure virtual

Close the file. Assumes no pending I/O requests are inflight for the specified file.

Implemented in UE::FGenericPlatformIoDispatcher.

DeleteRequest()

virtual void UE::IPlatformIoDispatcher::DeleteRequest ( FIoFileReadRequest  Request )

pure virtual

Delete the request. Must be called after the completion callback has been triggered.

Implemented in UE::FPlatformIoDispatcherBase.

Initialize()

virtual FIoStatus UE::IPlatformIoDispatcher::Initialize ( )

pure virtual

Initialize the dispatcher. Called after the config system has been initialized.

Implemented in UE::FPlatformIoDispatcherBase.

OpenFile()

virtual TIoStatusOr< FIoFileHandle > UE::IPlatformIoDispatcher::OpenFile ( const TCHAR *  Filename, const FIoFileProperties &  FileProperties, FIoFileStat *  OutStat = nullptr  )

pure virtual

Open file for reading. The file properties specifies whether the file is compressed, encrypted and signed.

Implemented in UE::FGenericPlatformIoDispatcher.

ReadDirect()

virtual FIoFileReadRequest UE::IPlatformIoDispatcher::ReadDirect ( FIoDirectReadRequestParams &&  Params, FIoFileReadRequestCompleted &&  OnCompleted  )

pure virtual

Issue a direct read request. Returns an invalid file handle if direct read is not supported for the specifid file.

Implemented in UE::FPlatformIoDispatcherBase.

ScatterGather()

virtual FIoFileReadRequest UE::IPlatformIoDispatcher::ScatterGather ( FIoScatterGatherRequestParams &&  Params, FIoFileReadRequestCompleted &&  OnCompleted  )

pure virtual

Issue a scatter-gather request.

Implemented in UE::FPlatformIoDispatcherBase.

Tick()

virtual bool UE::IPlatformIoDispatcher::Tick ( )

pure virtual

Tick the dispatcher. Only used when multithreading is disabled.

Implemented in UE::FPlatformIoDispatcherBase.

UpdatePriority()

virtual void UE::IPlatformIoDispatcher::UpdatePriority ( FIoFileReadRequest  Request, int32  NewPriority  )

pure virtual

Update priority for an inflight I/O request.

Implemented in UE::FPlatformIoDispatcherBase.

---

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

• Engine/Source/Runtime/Core/Internal/IO/PlatformIoDispatcher.h