FFileIoStore Class Reference

#include <IoDispatcherFileBackend.h>

Inheritance diagram for FFileIoStore:

Public Member Functions
	FFileIoStore (TUniquePtr< IPlatformFileIoStore > &&PlatformImpl)
	~FFileIoStore ()
void	Initialize (TSharedRef< const FIoDispatcherBackendContext > Context) override
void	Shutdown () override
virtual TIoStatusOr< FIoContainerHeader >	Mount (const TCHAR *InTocPath, int32 Order, const FGuid &EncryptionKeyGuid, const FAES::FAESKey &EncryptionKey, UE::IoStore::ETocMountOptions Options) override
virtual bool	Unmount (const TCHAR *InTocPath) override
void	ResolveIoRequests (FIoRequestList Requests, FIoRequestList &OutUnresolved) override
void	CancelIoRequest (FIoRequestImpl *Request) override
void	UpdatePriorityForIoRequest (FIoRequestImpl *Request) override
bool	DoesChunkExist (const FIoChunkId &ChunkId) const override
TIoStatusOr< uint64 >	GetSizeForChunk (const FIoChunkId &ChunkId) const
FIoRequestImpl *	GetCompletedIoRequests () override
TIoStatusOr< FIoMappedRegion >	OpenMapped (const FIoChunkId &ChunkId, const FIoReadOptions &Options) override
const TCHAR *	GetName () const override
virtual void	ReopenAllFileHandles () override
virtual bool	Init () override
virtual uint32	Run () override
virtual void	Stop () override
uint32	GetThreadId () const
Public Member Functions inherited from FRunnable
virtual void	Exit ()
virtual class FSingleThreadRunnable *	GetSingleThreadInterface ()
virtual	~FRunnable ()
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

FFileIoStore()

FFileIoStore::FFileIoStore

(

TUniquePtr< IPlatformFileIoStore > &&

PlatformImpl

)

~FFileIoStore()

FFileIoStore::~FFileIoStore

(

)

Member Function Documentation

CancelIoRequest()

void FFileIoStore::CancelIoRequest ( FIoRequestImpl *  Request )

overridevirtual

Cancel the I/O request.

Implements IIoDispatcherBackend.

DoesChunkExist()

bool FFileIoStore::DoesChunkExist ( const FIoChunkId &  ChunkId ) const

overridevirtual

Returns whether the chunk exists.

Implements IIoDispatcherBackend.

GetCompletedIoRequests()

FIoRequestImpl * FFileIoStore::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()

const TCHAR * FFileIoStore::GetName ( ) const

overridevirtual

Returns the name of this backend, for logging purposes

Implements IIoDispatcherBackend.

GetSizeForChunk()

TIoStatusOr< uint64 > FFileIoStore::GetSizeForChunk ( const FIoChunkId &  ChunkId ) const

virtual

Returns the size of the chunk.

Implements IIoDispatcherBackend.

GetThreadId()

uint32 FFileIoStore::GetThreadId

(

)

const

Init()

bool FFileIoStore::Init ( void  )

overridevirtual

Initializes the runnable object.

This method is called in the context of the thread object that aggregates this, not the thread that passes this runnable to a new thread.

Returns

True if initialization was successful, false otherwise

See also

Run, Stop, Exit

Reimplemented from FRunnable.

Initialize()

void FFileIoStore::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 > FFileIoStore::Mount ( const TCHAR *  InTocPath, int32  Order, const FGuid &  EncryptionKeyGuid, const FAES::FAESKey &  EncryptionKey, UE::IoStore::ETocMountOptions  Options  )

overridevirtual

Implements UE::IoStore::IFileIoDispatcherBackend.

OpenMapped()

TIoStatusOr< FIoMappedRegion > FFileIoStore::OpenMapped ( const FIoChunkId &  ChunkId, const FIoReadOptions &  Options  )

overridevirtual

Read the chunk as a memory mapped file.

Implements IIoDispatcherBackend.

ReopenAllFileHandles()

void FFileIoStore::ReopenAllFileHandles ( )

overridevirtual

Implements UE::IoStore::IFileIoDispatcherBackend.

ResolveIoRequests()

void FFileIoStore::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.

Run()

uint32 FFileIoStore::Run ( )

overridevirtual

Runs the runnable object.

This is where all per object thread work is done. This is only called if the initialization was successful.

Returns

The exit code of the runnable object

See also

Init, Stop, Exit

Implements FRunnable.

Shutdown()

void FFileIoStore::Shutdown ( )

overridevirtual

Called by the I/O dispatcher when shutting down.

Reimplemented from IIoDispatcherBackend.

Stop()

void FFileIoStore::Stop ( void  )

overridevirtual

Stops the runnable object.

This is called if a thread is requested to terminate early.

See also

Init, Run, Exit

Reimplemented from FRunnable.

Unmount()

bool FFileIoStore::Unmount ( const TCHAR *  InTocPath )

overridevirtual

Implements UE::IoStore::IFileIoDispatcherBackend.

UpdatePriorityForIoRequest()

void FFileIoStore::UpdatePriorityForIoRequest ( FIoRequestImpl *  Request )

overridevirtual

Update the priority of the I/O request.

Implements IIoDispatcherBackend.

---

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

• Engine/Source/Runtime/PakFile/Private/IoDispatcherFileBackend.h
• Engine/Source/Runtime/PakFile/Private/IoDispatcherFileBackend.cpp