UE::IoStore::FOnDemandIoBackend Class Reference

Inheritance diagram for UE::IoStore::FOnDemandIoBackend:

Public Member Functions
	FOnDemandIoBackend (const FOnDemandEndpointConfig &InConfig, FOnDemandIoStore &InIoStore, FOnDemandHttpThread &InHttpClient, TUniquePtr< IIasCache > &&InCache)
virtual	~FOnDemandIoBackend ()
virtual void	Initialize (TSharedRef< const FIoDispatcherBackendContext > Context) override
virtual void	Shutdown () override
virtual void	ResolveIoRequests (FIoRequestList Requests, FIoRequestList &OutUnresolved) override
virtual void	CancelIoRequest (FIoRequestImpl *Request) override
virtual void	UpdatePriorityForIoRequest (FIoRequestImpl *Request) override
virtual bool	DoesChunkExist (const FIoChunkId &ChunkId) const override
virtual bool	DoesChunkExist (const FIoChunkId &ChunkId, const FIoOffsetAndLength &ChunkRange) const override
virtual TIoStatusOr< uint64 >	GetSizeForChunk (const FIoChunkId &ChunkId) const override
virtual TIoStatusOr< uint64 >	GetSizeForChunk (const FIoChunkId &ChunkId, const FIoOffsetAndLength &ChunkRange, uint64 &OutAvailable) const
virtual FIoRequestImpl *	GetCompletedIoRequests () override
virtual TIoStatusOr< FIoMappedRegion >	OpenMapped (const FIoChunkId &ChunkId, const FIoReadOptions &Options) override
virtual const TCHAR *	GetName () const override
virtual void	SetBulkOptionalEnabled (bool bEnabled) override
virtual void	ReportAnalytics (TArray< FAnalyticsEventAttribute > &OutAnalyticsArray) const override
virtual TUniquePtr< IAnalyticsRecording >	StartAnalyticsRecording () const override
virtual FOnDemandStreamingCacheUsage	GetCacheUsage () const override
Public Member Functions inherited from UE::IoStore::IOnDemandIoDispatcherBackend
virtual	~IOnDemandIoDispatcherBackend ()=default

Constructor & Destructor Documentation

FOnDemandIoBackend()

UE::IoStore::FOnDemandIoBackend::FOnDemandIoBackend	(	const FOnDemandEndpointConfig &	InConfig,
		FOnDemandIoStore &	InIoStore,
		FOnDemandHttpThread &	InHttpClient,
		TUniquePtr< IIasCache > &&	InCache
	)

~FOnDemandIoBackend()

UE::IoStore::FOnDemandIoBackend::~FOnDemandIoBackend ( )

virtual

Member Function Documentation

CancelIoRequest()

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

overridevirtual

Cancel the I/O request.

Implements IIoDispatcherBackend.

DoesChunkExist() [1/2]

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

overridevirtual

Returns whether the chunk exists.

Implements IIoDispatcherBackend.

DoesChunkExist() [2/2]

bool UE::IoStore::FOnDemandIoBackend::DoesChunkExist ( const FIoChunkId &  ChunkId, const FIoOffsetAndLength &  ChunkRange  ) const

overridevirtual

Returns whether specified range of the chunk exists.

Reimplemented from IIoDispatcherBackend.

GetCacheUsage()

FOnDemandStreamingCacheUsage UE::IoStore::FOnDemandIoBackend::GetCacheUsage ( ) const

overridevirtual

Implements UE::IoStore::IOnDemandIoDispatcherBackend.

GetCompletedIoRequests()

FIoRequestImpl * UE::IoStore::FOnDemandIoBackend::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 * UE::IoStore::FOnDemandIoBackend::GetName ( ) const

overridevirtual

Returns the name of this backend, for logging purposes

Implements IIoDispatcherBackend.

GetSizeForChunk() [1/2]

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

overridevirtual

Returns the size of the chunk.

Implements IIoDispatcherBackend.

GetSizeForChunk() [2/2]

TIoStatusOr< uint64 > UE::IoStore::FOnDemandIoBackend::GetSizeForChunk ( const FIoChunkId &  ChunkId, const FIoOffsetAndLength &  ChunkRange, uint64 &  OutAvailable  ) const

virtual

Returns the size of the chunk and the size of the requested range.

Reimplemented from IIoDispatcherBackend.

Initialize()

void UE::IoStore::FOnDemandIoBackend::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.

OpenMapped()

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

overridevirtual

Read the chunk as a memory mapped file.

Implements IIoDispatcherBackend.

ReportAnalytics()

void UE::IoStore::FOnDemandIoBackend::ReportAnalytics ( TArray< FAnalyticsEventAttribute > &  OutAnalyticsArray ) const

overridevirtual

Implements UE::IoStore::IOnDemandIoDispatcherBackend.

ResolveIoRequests()

void UE::IoStore::FOnDemandIoBackend::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.

SetBulkOptionalEnabled()

void UE::IoStore::FOnDemandIoBackend::SetBulkOptionalEnabled ( bool  bEnabled )

overridevirtual

Implements UE::IoStore::IOnDemandIoDispatcherBackend.

Shutdown()

void UE::IoStore::FOnDemandIoBackend::Shutdown ( )

overridevirtual

Called by the I/O dispatcher when shutting down.

Reimplemented from IIoDispatcherBackend.

StartAnalyticsRecording()

TUniquePtr< IAnalyticsRecording > UE::IoStore::FOnDemandIoBackend::StartAnalyticsRecording ( ) const

overridevirtual

Implements UE::IoStore::IOnDemandIoDispatcherBackend.

UpdatePriorityForIoRequest()

void UE::IoStore::FOnDemandIoBackend::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/Experimental/IoStore/OnDemand/Private/OnDemandIoDispatcherBackend.cpp