UE::IoStore::FFileIoDispatcherBackend Class Reference

Inheritance diagram for UE::IoStore::FFileIoDispatcherBackend:

Public Member Functions
	FFileIoDispatcherBackend ()
virtual	~FFileIoDispatcherBackend ()
virtual TIoStatusOr< FIoContainerHeader >	Mount (const TCHAR *TocPath, int32 Order, const FGuid &EncryptionKeyGuid, const FAES::FAESKey &EncryptionKey, UE::IoStore::ETocMountOptions Options) override
virtual bool	Unmount (const TCHAR *TocPath) override
virtual void	ReopenAllFileHandles () override
virtual void	Initialize (TSharedRef< const FIoDispatcherBackendContext > Context) override
virtual void	Shutdown () override
virtual void	ResolveIoRequests (FIoRequestList Requests, FIoRequestList &OutUnresolved) override
virtual FIoRequestImpl *	GetCompletedIoRequests () override
virtual void	CancelIoRequest (FIoRequestImpl *Request) override
virtual void	UpdatePriorityForIoRequest (FIoRequestImpl *Request) override
virtual bool	DoesChunkExist (const FIoChunkId &ChunkId) const override
virtual TIoStatusOr< uint64 >	GetSizeForChunk (const FIoChunkId &ChunkId) const override
virtual TIoStatusOr< FIoMappedRegion >	OpenMapped (const FIoChunkId &ChunkId, const FIoReadOptions &Options) override
virtual const TCHAR *	GetName () const
Public Member Functions inherited from UE::IoStore::IFileIoDispatcherBackend
virtual	~IFileIoDispatcherBackend ()=default
Public Member Functions inherited from IIoDispatcherBackend
virtual bool	DoesChunkExist (const FIoChunkId &ChunkId, const FIoOffsetAndLength &ChunkRange) const
virtual TIoStatusOr< uint64 >	GetSizeForChunk (const FIoChunkId &ChunkId, const FIoOffsetAndLength &ChunkRange, uint64 &OutAvailable) const

Constructor & Destructor Documentation

FFileIoDispatcherBackend()

UE::IoStore::FFileIoDispatcherBackend::FFileIoDispatcherBackend

(

)

~FFileIoDispatcherBackend()

UE::IoStore::FFileIoDispatcherBackend::~FFileIoDispatcherBackend ( )

virtual

Member Function Documentation

CancelIoRequest()

void UE::IoStore::FFileIoDispatcherBackend::CancelIoRequest ( FIoRequestImpl *  Request )

overridevirtual

Cancel the I/O request.

Implements IIoDispatcherBackend.

DoesChunkExist()

bool UE::IoStore::FFileIoDispatcherBackend::DoesChunkExist ( const FIoChunkId &  ChunkId ) const

overridevirtual

Returns whether the chunk exists.

Implements IIoDispatcherBackend.

GetCompletedIoRequests()

FIoRequestImpl * UE::IoStore::FFileIoDispatcherBackend::GetCompletedIoRequests ( )

overridevirtual

Returns all completed request(s) to the I/O dispatcher. Triggered by invoking the wake-up callback on the backend context object.

Implements IIoDispatcherBackend.

GetName()

virtual const TCHAR * UE::IoStore::FFileIoDispatcherBackend::GetName ( ) const

inlinevirtual

Returns the name of this backend, for logging purposes

Implements IIoDispatcherBackend.

GetSizeForChunk()

TIoStatusOr< uint64 > UE::IoStore::FFileIoDispatcherBackend::GetSizeForChunk ( const FIoChunkId &  ChunkId ) const

overridevirtual

Returns the size of the chunk.

Implements IIoDispatcherBackend.

Initialize()

void UE::IoStore::FFileIoDispatcherBackend::Initialize ( TSharedRef< const FIoDispatcherBackendContext >  Context )

overridevirtual

Called by the I/O dispatcher once initialized.

Parameters

Context

Context object used for signalling the I/O dispatcher.

Implements IIoDispatcherBackend.

Mount()

TIoStatusOr< FIoContainerHeader > UE::IoStore::FFileIoDispatcherBackend::Mount ( const TCHAR *  TocPath, int32  Order, const FGuid &  EncryptionKeyGuid, const FAES::FAESKey &  EncryptionKey, UE::IoStore::ETocMountOptions  Options  )

overridevirtual

Implements UE::IoStore::IFileIoDispatcherBackend.

OpenMapped()

TIoStatusOr< FIoMappedRegion > UE::IoStore::FFileIoDispatcherBackend::OpenMapped ( const FIoChunkId &  ChunkId, const FIoReadOptions &  Options  )

overridevirtual

Read the chunk as a memory mapped file.

Implements IIoDispatcherBackend.

ReopenAllFileHandles()

void UE::IoStore::FFileIoDispatcherBackend::ReopenAllFileHandles ( )

overridevirtual

Implements UE::IoStore::IFileIoDispatcherBackend.

ResolveIoRequests()

void UE::IoStore::FFileIoDispatcherBackend::ResolveIoRequests ( FIoRequestList  Requests, FIoRequestList &  OutUnresolved  )

overridevirtual

Create asynchronous read requests for the list of I/O request(s). The request(s) can span multiple chunks.

Parameters

Requests	Request(s) to resolve.
OutUnresolved	Unresolved request(s) returned to the I/O dispatcher.

Implements IIoDispatcherBackend.

Shutdown()

void UE::IoStore::FFileIoDispatcherBackend::Shutdown ( )

overridevirtual

Called by the I/O dispatcher when shutting down.

Reimplemented from IIoDispatcherBackend.

Unmount()

bool UE::IoStore::FFileIoDispatcherBackend::Unmount ( const TCHAR *  TocPath )

overridevirtual

Implements UE::IoStore::IFileIoDispatcherBackend.

UpdatePriorityForIoRequest()

void UE::IoStore::FFileIoDispatcherBackend::UpdatePriorityForIoRequest ( FIoRequestImpl *  Request )

overridevirtual

Update the priority of the I/O request.

Implements IIoDispatcherBackend.

---

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

• Engine/Source/Runtime/PakFile/Private/FileIoDispatcherBackend.cpp